Add brief docs on releasing
This commit is contained in:
21
README.md
21
README.md
@ -268,6 +268,14 @@ Additional authorization enhancers could include:
|
||||
- **`wiki-plugin-delegation`**: Temporary access delegation
|
||||
- **`wiki-plugin-webhooks`**: Webhook authentication
|
||||
|
||||
## Releasing
|
||||
|
||||
1. Make changes
|
||||
2. `git commit`
|
||||
3. `git push`
|
||||
4. `npm version <patch|minor|major>`
|
||||
5. `npm publish` (you might need to `npm login` first)
|
||||
|
||||
## Miscellaneous
|
||||
|
||||
### TODOs
|
||||
@ -504,3 +512,16 @@ If this composable architecture were adopted by the core wiki server, the asset
|
||||
3. **Eliminate** the assumption that `security_type` equals the package containing client assets
|
||||
|
||||
This represents one of the key areas where the composable architecture has to work around existing server assumptions rather than requiring server modifications.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Docker image fails to build with wiki-security-passportjs version conflict
|
||||
|
||||
If `fedwiki/wiki` bumps [the required version of `wiki-security-passportjs`](https://github.com/fedwiki/wiki/blob/main/package.json#L69), it will need to be updated here as well:
|
||||
|
||||
```
|
||||
# edit package.json and change the version of `wiki-security-passportjs`
|
||||
npm update
|
||||
```
|
||||
|
||||
Then commit and release.
|
||||
|
||||
Reference in New Issue
Block a user