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

Dev doc refactor release instructions #1057

Merged
merged 7 commits into from
May 21, 2024

Conversation

petersilva
Copy link
Contributor

@petersilva petersilva commented May 18, 2024

Hi folks, This is a bit of a re-factor of the Developer's guide. No code.

How to do a Release has actually gotten relatively far from the original vision of a totally automated process. In the developer's guide to date, all of the pieces for how to do a release were present, but it was scatterred around and a there was, as they say, some assembly required.

The new Release manual is a document solely about creating a release. It goes over:

  • quality assurance required before tagging a version as a pre-release
  • the mechanics of tagging a pre-release
  • getting packages built for ubuntu with Launchpad.
  • how to manually build redhat8 packages
  • how to build the windows self-extracting executable.
  • the process of creating a github release.

It's very manual. If folks want to automate bits of it... Please do so, but for now, this at least documents what needs to be done to perform a software release.

It's also a lot easier to find, as I don't actually use the Developer's guide except to make releases, and I found the release information hard to find before. Now it's at least in one place, and fairly sequential.

@petersilva petersilva added the Documentation Primary deliverable of this item is documentation label May 18, 2024
@petersilva petersilva requested a review from mshak2 May 18, 2024 04:24
@petersilva petersilva marked this pull request as ready for review May 21, 2024 15:22
@petersilva petersilva merged commit 00036ba into development May 21, 2024
53 of 64 checks passed
@petersilva petersilva deleted the dev_doc_refactor_release_instructions branch June 6, 2024 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Primary deliverable of this item is documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant