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.

Sign up for GitHub

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

Jump to bottom

Simplify release instructions #3252

Merged
merged 12 commits into from
Jul 18, 2024
Merged

Simplify release instructions #3252

merged 12 commits into from
Jul 18, 2024

Conversation

maxkfranz
Copy link
Member

@maxkfranz maxkfranz commented Jul 2, 2024 •
edited
Loading

Related issues

Notes re. the content of the pull request.

  • Set the default branch to unstable for feature releases.
  • Set the default branch to master for patch releases.
  • Simplify instructions: patch & feature only (no back-port)
  • Delete backport issue template

Checklist

Author:

  • The proper base branch has been selected. New features go on unstable. Bug-fix patches can go on either unstable or master.
  • N/A -- Automated tests have been included in this pull request, if possible, for the new feature(s) or bug fix. Check this box if tests are not pragmatically possible (e.g. rendering features could include screenshots or videos instead of automated tests).
  • N/A -- The associated GitHub issues are included (above).
  • Notes have been included (above).

Reviewers:

  • All automated checks are passing (green check next to latest commit).
  • At least one reviewer has signed off on the pull request.
  • For bug fixes: Just after this pull request is merged, it should be applied to both the master branch and the unstable branch. Normally, this just requires cherry-picking the corresponding merge commit from master to unstable -- or vice versa.

@maxkfranz
Update the release instructions
b0fd917 
- Set the default branch to unstable for feature releases.
- Set the default branch to master for patch releases.
- Simplify instructions: patch & feature only (no back-port)
@maxkfranz
Delete backport issue template
99db106
@maxkfranz
Copy link
Member Author

Updated instructions:

Background

  • Ensure that a milestone exists for the release you want to make, with all the issues for that release assigned in the milestone.
  • Bug fixes should be applied to both the master and unstable branches. PRs can go on either branch, with the patch applied to the other branch after merging.
  • When a patch release is made concurrently with a feature release, the patch release should be made first. Wait 5 minutes after the patch release completes before starting the feature release -- otherwise Zenodo doesn't pick up releases properly.

Patch version

  1. Go to Actions > Feature release
  2. Go to the 'Run workflow' dropdown
  3. [Optional] The 'master' branch should be preselected for you
  4. Press the green 'Run workflow' button
  5. Close the milestone for the release

Feature version

  1. Go to Actions > Feature release
  2. Go to the 'Run workflow' dropdown
  3. [Optional] The 'unstable' branch should be preselected for you
  4. Press the green 'Run workflow' button
  5. Close the milestone for the release
  6. Make the release announcement on the blog

@maxkfranz
Clean up release script: pre_release_test.sh
11d21b8 
- Enable `set -e`
- Proper exit statements
- Fix if
- Add "dist/cytoscape.umd.js" dist file to check for release
- Quote variables
@maxkfranz
Clean up release script: new-patch-version.sh
79423cf 
- Comments
- Quote variables
@maxkfranz
Review release script: new-feature-version.sh
97dee75 
- Comments
- Quote variables
@maxkfranz
Clean up release script: merge_unstable_to_master.sh
60cdfef 
- Proper exits
- Comments
- Quote variables
- Fix bogus branch_name ref -- checkout master instead for backport branch step
@maxkfranz
Update documentation for release file table : cytoscape.esm.mjs
0f74d8e
@maxkfranz
BRANCH=${{ github.event.inputs.branch }}
330aa66
@maxkfranz
Checks should be on local f/s
afec96d
@maxkfranz
Use cpy --flat
3441bf0
@maxkfranz
Remove versions.json check since it's created earlier in the pipeline
f23ca8c
@cloudflare-pages Cloudflare Pages
Copy link

cloudflare-pages bot commented Jul 16, 2024 •
edited
Loading

Deploying cygpu with  Cloudflare Pages  Cloudflare Pages

Latest commit: f05e4f4
Status:🚫  Build failed.

View logs

@maxkfranz
Copy link
Member Author

@mikekucera @chrtannus @gbader

The latest changes in this branch have fixed the release process. It's been verified in a fork.

@maxkfranz
Copy link
Member Author

@mikekucera I've disabled CF pages for every branch but the gpu one:

Screenshot 2024-07-16 at 16 21 39

@maxkfranz maxkfranz merged commit 93d2b9e into unstable Jul 18, 2024
2 of 3 checks passed
maxkfranz added a commit that referenced this pull request Jul 18, 2024
@maxkfranz
Cherry-pick to master: Merge pull request #3252 from cytoscape/fix/au…
0269057 
…to-rel-instr

Simplify release instructions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrtannus chrtannus Awaiting requested review from chrtannus

@mikekucera mikekucera Awaiting requested review from mikekucera

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@maxkfranz