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

Freeze the cert-manager 1.15 docs #1577

Merged

Conversation

wallrj
Copy link
Member

@wallrj wallrj commented Oct 3, 2024

Preview: https://deploy-preview-1577--cert-manager.netlify.app/v1.15-docs/

Following the updated instructions from the release process:

(final release only) Freeze the docs/ folder by creating a copy , removing the
pages from that copy that don't make sense to be versioned, and updating the
manifest.json file:

export RELEASE=1.15
cp -r content/docs content/v${RELEASE}-docs
rm -rf content/v${RELEASE}-docs/{installation/supported-releases,installation/upgrading,release-notes,contributing}
sed -i.bak "s|docs/|v${RELEASE}-docs/|g" content/v${RELEASE}-docs/manifest.json
jq < content/v${RELEASE}-docs/manifest.json >/tmp/manifest \
  'del(.routes[0].routes[] | select(.title | test("Releases|Contributing")))'
mv /tmp/manifest content/v${RELEASE}-docs/manifest.json

I updated the instructions in the release process because it wasn't dropping the contributing section,
and it was mangling the api-docs.

@cert-manager-prow cert-manager-prow bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 3, 2024
@wallrj wallrj force-pushed the freeze-cert-manager-1.15-docs branch 2 times, most recently from 1fd1d4f to b4e5099 Compare October 3, 2024 12:46
Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit b7c0d96
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager/deploys/66fec90d9ad8ca0008ce8ef6
😎 Deploy Preview https://deploy-preview-1577--cert-manager.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@wallrj wallrj force-pushed the freeze-cert-manager-1.15-docs branch from b4e5099 to 053e615 Compare October 3, 2024 16:13
wallrj added 2 commits October 3, 2024 17:40
Following the instructions from the release process
> (final release only) Freeze the docs/ folder by creating a copy , removing the
> pages from that copy that don't make sense to be versioned, and updating the
> manifest.json file:

```bash
export RELEASE=1.15
cp -r content/docs content/v${RELEASE}-docs
rm -rf content/v${RELEASE}-docs/{installation/supported-releases,installation/upgrading,release-notes,contributing}
sed -i.bak "s|docs/|v${RELEASE}-docs/|g" content/v${RELEASE}-docs/manifest.json
jq < content/v${RELEASE}-docs/manifest.json >/tmp/manifest \
  'del(.routes[0].routes[] | select(.title | test("Releases|Contributing")))'
mv /tmp/manifest content/v${RELEASE}-docs/manifest.json
```

Signed-off-by: Richard Wall <[email protected]>
@wallrj wallrj force-pushed the freeze-cert-manager-1.15-docs branch from 053e615 to b7c0d96 Compare October 3, 2024 16:40
@wallrj wallrj requested a review from maelvls October 3, 2024 16:46
Copy link
Member

@maelvls maelvls left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've looked at the release process change, thanks for updating the instructions!

I haven't been able to read it all, but it looks like the changes make sense.

/lgtm
/approve

@cert-manager-prow cert-manager-prow bot added the lgtm Indicates that a PR is ready to be merged. label Oct 7, 2024
@cert-manager-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maelvls

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@cert-manager-prow cert-manager-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 7, 2024
@cert-manager-prow cert-manager-prow bot merged commit 9dbf33f into cert-manager:master Oct 7, 2024
7 checks passed
@wallrj wallrj deleted the freeze-cert-manager-1.15-docs branch October 7, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants