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

[Feature] Create a release #19

Closed
TimidRobot opened this issue Feb 2, 2022 · 4 comments
Closed

[Feature] Create a release #19

TimidRobot opened this issue Feb 2, 2022 · 4 comments
Assignees
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟥 priority: critical Must be fixed ASAP 🏁 status: ready for work Ready for work

Comments

@TimidRobot
Copy link
Member

TimidRobot commented Feb 2, 2022

Problem

  1. Production/Staging installation is done via composer
  2. composer uses releases
  3. there is not yet a release

Description

Create a release

Additional context

  • "External" Composer version numbers must be prefixed with v (ex. v0.1.0)
  • "Internal" Composer version numbers and WordPress version numbers must not be prefixed (ex. 0.1.0)
    • composer.json
    • PHP files
    • WordPress readme.txt
    • etc.
@TimidRobot TimidRobot added 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository labels Feb 2, 2022
@TimidRobot TimidRobot changed the title [Feature] Release a new version [Feature] Create a release Feb 2, 2022
@TimidRobot TimidRobot added this to Ready for Development in Active Sprint via automation Feb 2, 2022
@TimidRobot TimidRobot added 🏁 status: ready for work Ready for work 🟥 priority: critical Must be fixed ASAP and removed 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Feb 2, 2022
@brylie
Copy link
Contributor

brylie commented Feb 3, 2022

Hei @TimidRobot. I can't find the Composer docs related to the external version number prefixing. All I have found are the following, which don't seem to indicate the v prefix.

I don't mind following the v prefix convention if it is mandatory but would prefer dropping the v if things work without it.

@brylie
Copy link
Contributor

brylie commented Feb 3, 2022

@brylie brylie closed this as completed Feb 3, 2022
Active Sprint automation moved this from Ready for Development to Done Feb 3, 2022
@TimidRobot
Copy link
Member Author

TimidRobot commented Feb 3, 2022

@brylie I added the v prefix requirements to our WordPress Development Process internal documentation on 2021-07-01. Unfortunately, I did not document the exact error encountered.

SemVer required the prefix in the past (ex. semver/semver#1, semver/semver#204, https://stackoverflow.com/a/2011372), but I can't find anything concrete about composer requiring it. I suspect it's poorly documented because removing a requirement is a non-breaking change.

I recommend we experiment with non-prefixed tags/releases on a non-essential or test package. Or that we wait until we're not under a deadline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟥 priority: critical Must be fixed ASAP 🏁 status: ready for work Ready for work
Projects
Active Sprint
  
Done
Development

No branches or pull requests

2 participants