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.

Sign up for GitHub

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

Jump to bottom

Add context to documentation deprecations #9975

Closed
geospatialem opened this issue Aug 6, 2024 · 2 comments
Closed

Add context to documentation deprecations #9975

geospatialem opened this issue Aug 6, 2024 · 2 comments
Assignees
@geospatialem @DitwanP
Labels
4 - verified Issues that have been released and confirmed resolved. estimate - 3 A day or two of work, likely requires updates to tests. p - high Issue should be addressed in the current milestone, impacts component or core functionality tooling Issues relating to build system fixes or improvements.
Milestone
2024-09-30 - 2.13...

Comments

@geospatialem
Copy link
Member

Priority impact

p - high

Summary

Allow team members to specify a convention type commit that will add a doc-only change to our changelog to ensure deprecations are communicated to internal teams and users.

Desired Outcome

Where we deprecate properties or values, we should be able to have certain commits automatically added, via our CI, to the changelog.

For instance:

Resources

No response
@geospatialem geospatialem added tooling Issues relating to build system fixes or improvements. p - high Issue should be addressed in the current milestone, impacts component or core functionality 0 - new New issues that need assignment. estimate - 3 A day or two of work, likely requires updates to tests. labels Aug 6, 2024
@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. and removed 0 - new New issues that need assignment. labels Aug 6, 2024
@DitwanP DitwanP added 2 - in development Issues that are actively being worked on. and removed 1 - assigned Issues that are assigned to a sprint and a team member. labels Sep 11, 2024
@DitwanP DitwanP mentioned this issue Sep 19, 2024
Merged
DitwanP added a commit that referenced this issue Sep 26, 2024
@DitwanP
ci(changelog): add deprecation commits to changelog automation (#10346)
89194b0 
**Related Issue:** #9975 

## Summary
Adds custom type list to lerna and release-please config files, and add
a deprecation type to the list. This should allow for tracking
deprecations in the change-logs
@DitwanP DitwanP added 3 - installed Issues that have been merged to master branch and are ready for final confirmation. and removed 2 - in development Issues that are actively being worked on. labels Sep 26, 2024
@github-actions GitHub Actions
Copy link
Contributor

Installed and assigned for verification.

@DitwanP
Copy link
Contributor

DitwanP commented Sep 27, 2024

Closing as complete for now, will actually verify in future release.
Screenshot 2024-05-21 at 11 06 30 AM

@DitwanP DitwanP closed this as completed Sep 27, 2024
@DitwanP DitwanP added 4 - verified Issues that have been released and confirmed resolved. and removed 3 - installed Issues that have been merged to master branch and are ready for final confirmation. labels Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@geospatialem geospatialem

@DitwanP DitwanP

Labels
4 - verified Issues that have been released and confirmed resolved. estimate - 3 A day or two of work, likely requires updates to tests. p - high Issue should be addressed in the current milestone, impacts component or core functionality tooling Issues relating to build system fixes or improvements.
Projects
None yet
Milestone
2024-09-30 - 2.13.0 Sep Main release
Development

No branches or pull requests
2 participants
@geospatialem @DitwanP