Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider using zotero-plugin release script instead of release-it #303

Open
wants to merge 1 commit into
base: zotero7
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions .github/workflows/release.yml → .github/workflows/push.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: release
name: push

on:
push:
Expand Down Expand Up @@ -73,21 +73,11 @@ jobs:

- name: release
run: |
npm run release -- --no-increment --no-git --github.release --ci --VV
npm run release
sleep 1s
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: upload update.json
uses: meeDamian/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
tag: update
files: build/update*.json
allow_override: true
gzip: false


- name: Notify release
uses: apexskier/github-release-commenter@v1
continue-on-error: true
Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,20 @@ Cita is collaboratively translated at translatewiki.net. Would you like to help

## Publishing

1. Decide a new version number vX.Y.Z using [Semantic Versioning](https://semver.org/), and depending on whether it's a beta release or not.
2. `npm run release` and choose this version number and the version will be automatically bumped in `package.json` and the release tagged. This will trigger github actions to build the code and make a new release at this version
3. Until integration tests have been implemented (#30), install the new version on a fresh Zotero profile and run some manual tests.
Until integration tests have been implemented (#30), install the new version on a fresh Zotero profile and run some
manual tests before publishing a new release.

1. Run `npm run release`. This will run `zotero-plugin release` (see https://github.com/windingwind/zotero-plugin-template/tree/main#repo-content-pjax-container):
1. You will be prompted for the new version number.
1. The version will be bumped locally.
1. A new commit will be created and tagged with the version number.
1. Both commit and tag will be pushed to GitHub.
1. On Github, `npm run release` will be run again by GitHub actions. This time version won't be bumped again and no
new commits or tags will be created. Instead:
1. `npm run build` will be run
1. A new release will be published, including the xpi file built as asset.
1. A separate "release" release will be created or updated, which includes the `update.json` and `update-beta.json`
update manifests as assets.

## Acknowledgements

Expand Down
Loading