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

2.1.0 release #1834

Closed
27 tasks done
brockfanning opened this issue Oct 17, 2022 · 0 comments
Closed
27 tasks done

2.1.0 release #1834

brockfanning opened this issue Oct 17, 2022 · 0 comments

Comments

@brockfanning
Copy link
Contributor

brockfanning commented Oct 17, 2022

In the steps below, "all four repos" refers to open-sdg, sdg-build, sdg-translations, and jekyll-open-sdg-plugins.

Releasing the "beta1" version (eg 2.0.0-beta1)

  • Create a new dev branch (eg, 2.1.0-dev) in all four repos
  • Make these new dev branches the default branch for all four repos
  • Update the "Repository branch" in Weblate to point to the new dev branch
  • In the new dev branch for open-sdg, make sure that tests run against the new dev branches for the other repos, by updating these files:
    • tests/site/Gemfile
    • tests/data/requirements.txt
  • Bump the version in this file and publish the beta1 version of jekyll-open-sdg-plugins to rubygems.org, eg:
    • gem build jekyll-open-sdg-plugins.gemspec
    • gem push jekyll-open-sdg-plugins-1.5.0.pre.beta1.gem
  • Push the beta tag for all four repos
  • Create a PR against the old dev branch with upgrade instructions (specific to the beta1 branches) and tweaks to the docs/updates.md file
  • Do testing, pushing new beta2/beta3/etc tags as needed

Releasing the new version (eg 2.0.0)

A. Changelogs and versions

  1. Make sure these open-sdg files have been updated:
    • docs/changelog.md
    • docs/updates.md
  2. Make sure these sdg-build files have been updated:
    • CHANGELOG.md
    • README.md
    • setup.py (version number)
  3. Make sure these sdg-translations files have been updated:
    • www/changelog.md (currently out of date)
  4. Make sure these jekyll-open-sdg-plugins files have been updated:
    • lib/jekyll-open-sdg-plugins/version.rb (version number)
  5. Make sure the upgrade instructions have been added to docs/upgrades/.

B. Translations

  1. Make sure that any new translations have been translated into all languages. Use machine translation for this, and mark them as "Needs edit" so that a human translator can eventually edit/approve. This has now been automated for all translation groups except for global_indicators, global_targets, and global_goals, thanks to the "Automatic translation" add-on in Weblate.
  2. Make sure that Weblate has no pending commits and the Weblate pull-request has been merged.

C. Tags and branches

  1. Push the new tag for all four repos.
  2. Merge the old dev branch into the new dev branch for all four repos. Eg, if releasing version 1.3.0, merge 1.3.0-dev into 1.4.0-dev.
  3. Merge the old dev branch into the master branch for all four repos. Eg, if releasing version 1.3.0, merge 1.3.0-dev into master.

D. Packages

  1. Build ("gem build") and push ("gem push") the jekyll-open-sdg-plugins gem to rubygems.org
  2. (Not implemented yet) Publish sdg-build to pypi.org.

E. Starter repositories

  1. Update the open-sdg-data-starter to point to the new tags, by updating these files:
  2. Update the open-sdg-site-starter to point to the new tags, by updating these files:
  3. Update the open-sdg-simple-starter to point to the new tags, by updating these files:
  4. If this release contains any "recommended but optional" features, configure them in the starter repos as needed.

F. Outreach

  1. Create "Releases" in Github for all 4 projects
  2. Create a release video
  3. Create a post on open-sdg.org
  4. Social media announcements
@brockfanning brockfanning added bug - unconfirmed Bug that has not be reproduced yet and removed bug - unconfirmed Bug that has not be reproduced yet labels Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant