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

(CONT-1026) Deprecate release command set #1251

Closed
wants to merge 10 commits into from

Conversation

chelnak
Copy link
Contributor

@chelnak chelnak commented May 30, 2023

The release prep command introduces a dependency on the github-changelog-generator gem which is unmaintained and broken.

This PR exists primarily to remove this command but that introduces an unnecessary level of commands for users. For example

pdk release
pdk release prep
pdk release publish

Additionally as part of this ticket, we lift up the publish command to the root level so we have the following:

pdk publish

Due to the fact that pdk publish now has the single responsibility of publishing to the forge, pdk build has been changed to perform some pre-build checks, much like the old release command did.

By default, pdk build will now

  • Run validations against the module
  • Generate documentation

Each step can be skipped by using the respective flag:

  • --skip-validation
  • --skip-documentation

@chelnak chelnak requested a review from a team as a code owner May 30, 2023 12:04
@chelnak chelnak force-pushed the CONT-1026-deprecate_release_commands branch from cb27e3c to 2383a46 Compare May 30, 2023 12:05
@chelnak chelnak self-assigned this May 30, 2023
@chelnak chelnak force-pushed the CONT-1026-deprecate_release_commands branch from 2383a46 to 1cd80d0 Compare May 30, 2023 12:33
@chelnak chelnak changed the title Cont 1026 deprecate release commands (CONT-1026) Deprecate release command set May 30, 2023
@chelnak chelnak force-pushed the CONT-1026-deprecate_release_commands branch from 1cd80d0 to 4281655 Compare June 13, 2023 12:55
@chelnak chelnak force-pushed the CONT-1026-deprecate_release_commands branch 2 times, most recently from 394a5f9 to e2c3f0f Compare June 20, 2023 15:13
The release prep command introduces a dependency on the github-changelog-generator
gem which is unmaintained and broken.

This ticket exists primarily to remove this command but that introduces
an unnecessary level of commands for users. For example

```
pdk release
pdk release prep
pdk release publish
```

This change deprecates the `release` command set. They will be removed
in a future version.
To reduce complexity, this change introduces a new `publish` top-level
command.

The intention is to replace `pdk release` and `pdk release publish`
@chelnak chelnak force-pushed the CONT-1026-deprecate_release_commands branch from f0f3ed8 to cb092b7 Compare June 23, 2023 08:56
@chelnak chelnak force-pushed the CONT-1026-deprecate_release_commands branch from cb092b7 to 23b51a8 Compare June 23, 2023 09:07
@david22swan david22swan reopened this Nov 30, 2023
@david22swan david22swan requested a review from a team as a code owner November 30, 2023 10:34
@pmcmaw pmcmaw marked this pull request as draft April 5, 2024 10:40
@donoghuc donoghuc closed this Jun 6, 2024
@donoghuc donoghuc deleted the CONT-1026-deprecate_release_commands branch June 6, 2024 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants