This repository stores the content that publishes to the PCF versioned release notes.
All release notes are stored in version-specific branches. Do not use the MASTER branch for release note content.
Create Release Notes
When you create release notes, create them in the branch of this repository that corresponds to the product version number you are updating. Release notes for versioned products publish from the branch of the same name. For example, we publish the PCF 1.11 Release Notes using the content of the 1.11 branch of this reposirtory.
Publish or Update Release Notes
Change and additions to the content in an existing branch of this repository automatically trigger the cf-release-notes
Concourse pipeline run by the PCF Documention team:
https://concourse.run.pivotal.io/teams/cf-docs/pipelines/cf-release-notes
This pipeline automatically publishes release notes to a staging environment. Once published to a staging environment, someone should review the results to verify the content and formatting. After verification, someone must manually trigger publishing to a production site.
Contact the PCF Documentation team to publish your release notes to a production site, either through Slack (#pcf-docs in the Pivotal organization) or by email (cf-docs@pivotal.io).
If you have access permission to the cf-release-notes Concourse pipeline, you can publish your release notes to a
production site without contacting the PCF Documentation team. In general, we only recommend this for small changes.
If you have access permission to the cf-release-notes Concourse pipeline, follow the steps below to update release notes on a production site:
-
Update, commit, and changes to a branch of this repository.
-
Verify that your updates publish to the appropriate staging site correctly. You may need to refresh the site in your browser to see the changes.
-
Open the appropriate tab in Concourse, click the production box, then click the + button in the top right to start a production build.