Skip to content

Document release process for Crossplane extensions. #913

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

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

Conversation

jastang
Copy link
Member

@jastang jastang commented Apr 9, 2025

Adds a new Guide detailing the conventional release process with GitHub Actions for Crossplane extensions.

Fixes #785

Copy link

netlify bot commented Apr 9, 2025

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit 5e5345b
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/67f62932f14a9e000834d837
😎 Deploy Preview https://deploy-preview-913--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 84 (🔴 down 3 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 83 (no change from production)
SEO: 100 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

Signed-off-by: Jason Tang <[email protected]>
@jastang jastang force-pushed the 785-extensions-release-process branch from 69668fc to 5e5345b Compare April 9, 2025 08:00
@jastang jastang requested a review from jbw976 April 9, 2025 08:02
Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

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

This is a great start @jastang, thank you for stepping up to take on a long annoying gap in the community's knowledge base! 🙇‍♂️

I think we're still missing some high level and general information for folks that aren't ready to see the details of pipeline steps. Could you consider adding two IMO important focus areas to this guide?

  • A high level general outline of what an extension release is, how the parts all fit together
  • A practical set of steps that they follow to release their extension. This will probably be THE most useful and popular section of this guide. People would hopefully be able to come to this list and mostly follow it without thinking too much 😉


{{< hint "note" >}}
Some custom workflows may accept an explicit input for the remote reference,
which overrides inferring from a git ref or tag. The [`ci.yml`] file for
Copy link
Member

Choose a reason for hiding this comment

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


### Configure target registry

The provider template repository includes a top-level `Makefile`. Edit
Copy link
Member

Choose a reason for hiding this comment

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

a link to the makefile or at least the provider template repo here would be very helpful

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

Successfully merging this pull request may close these issues.

Document how to release Crossplane extensions (providers, functions, etc.)
2 participants