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

4 consolidate hosted osi documentation sources #5

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

philipwindecker
Copy link
Collaborator

No description provided.

Signed-off-by: Philip WINDECKER (AVENYR GmbH) <[email protected]>
Signed-off-by: Philip WINDECKER (AVENYR GmbH) <[email protected]>
@philipwindecker philipwindecker linked an issue Oct 22, 2024 that may be closed by this pull request
@philipwindecker philipwindecker self-assigned this Oct 22, 2024
@jdsika jdsika added the documentation Improvements or additions to documentation label Oct 23, 2024
@jdsika
Copy link

jdsika commented Oct 23, 2024

Do we have to adjust the workflow with every new release excluding the previous ones? What is the goal here? Trigger only on the latest release without -rc* ?

@philipwindecker
Copy link
Collaborator Author

Do we have to adjust the workflow with every new release excluding the previous ones? What is the goal here? Trigger only on the latest release without -rc* ?

I discussed this a bit in the issue : #4

Basically, I see the following options:

  1. At the beginning of development, the new release is configured to be prerelease: true. This would mean, that latest will always point to the latest released version, never the current working one. Those will still be visible, however.
  2. We do not use prerelease and exclude unwanted versions manually in the "site.yml". This can also be done for older version, where the group does not want it to be used any longer (and thus removes the hosted documentation).

Both can be done manually or automatically, the latter would, however, require changes in either the pipeline or an Antora extension.

To sketch things out a bit more:

Using prerelease (manually)

  • Set attribute prerelease either after a successful release or at the beginning of the next cycle (I would prefer the latter) to true
  • Work on the release
  • Do release candidates
  • Add any feedback
  • Prepare for release
    • Last step: Set prerelease: false in "antora.yml"
  • Create the release

Using exclusion

  • Work on release
  • Do release candidates
  • Add any feedback
  • Prepare for release
    • During this phase (at any point): Add exceptions for relevant release candidates
  • Create the release

@philipwindecker
Copy link
Collaborator Author

Regarding automation, the prerelease could always be true and the release pipeline sets it to false with a custom commit before the build is triggered (and back to true afterwards in a cleanup job).
We trigger pushes for the release already (because we need to create tags and update certain content anyway), so it would not be something completely different.

In case of the other solution, the same pipeline could instead get a job that adds sth like <tag>-rc* to the exceptions if the release is not a release candidate before the build job.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consolidate Hosted OSI Documentation Sources
2 participants