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 #1297

Closed
wants to merge 12 commits into from

Conversation

david22swan
Copy link
Member

@david22swan david22swan commented Nov 30, 2023

Rebased duplicate of: #1251

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

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`
@david22swan david22swan requested a review from a team as a code owner November 30, 2023 10:46
Copy link
Contributor

@pmcmaw pmcmaw left a comment

Choose a reason for hiding this comment

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

Following feedback from Marty - I don't think this is the route we should take.

@david22swan david22swan closed this Dec 5, 2023
@jordanbreen28 jordanbreen28 deleted the CONT-1026/main/deprecate_release branch February 13, 2024 17:38
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