Skip to content

Automate updating project page with latest release #11308

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

Closed
sjohnr opened this issue May 31, 2022 · 0 comments
Closed

Automate updating project page with latest release #11308

sjohnr opened this issue May 31, 2022 · 0 comments
Assignees
Labels
in: build An issue in the build theme: build-automation Build enhancements and reusability for automating releases, sending notifications, etc. type: task A general task

Comments

@sjohnr
Copy link
Contributor

sjohnr commented May 31, 2022

The existing gradle task (./gradlew saganCreateRelease saganDeleteRelease -PnextVersion=$nextVersion -PpreviousVersion=$previousVersion) can be used to update the project page. We will need to account for handling SNAPSHOT versions, so this could be added to continuous-integration-workflow.yml as a separate task (not in the jobs.create_release job since it only runs for releases) as follows:

  1. Check if the current version exists
  2. If it exists, do nothing
  3. If it does not exist, update the project page:
    • Create the next version using the saganCreateRelease task with the current reference/api documentation links and the current project version
      • Note: Each branch may need separate/adjusted rules for the correct links since 5.2 to 5.5 use an asciidoctor site and 5.6+ use an Antora site.
    • Delete the previous version using the saganDeleteRelease task
      • Note: Requires additional logic to calculate/discover the previous version.

See https://spring.io/restdocs/index.html#release.

@sjohnr sjohnr added in: build An issue in the build type: task A general task labels May 31, 2022
@sjohnr sjohnr added this to the 5.8.x milestone May 31, 2022
@sjohnr sjohnr modified the milestones: 5.8.x, 6.0.x Jun 3, 2022
@rwinch rwinch removed this from the 6.0.x milestone Jul 5, 2022
@sjohnr sjohnr mentioned this issue Feb 21, 2023
11 tasks
@sjohnr sjohnr mentioned this issue May 12, 2023
15 tasks
@sjohnr sjohnr added the theme: build-automation Build enhancements and reusability for automating releases, sending notifications, etc. label Jul 6, 2023
sjohnr added a commit that referenced this issue Feb 2, 2024
@sjohnr sjohnr closed this as completed in f11ba8f Feb 2, 2024
@sjohnr sjohnr self-assigned this Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: build An issue in the build theme: build-automation Build enhancements and reusability for automating releases, sending notifications, etc. type: task A general task
Projects
None yet
Development

No branches or pull requests

2 participants