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

Maintenance: revisit automation for Issues and PR's #133

Closed
7 tasks done
saragerion opened this issue Jul 23, 2021 · 6 comments · Fixed by #1431 or #1437
Closed
7 tasks done

Maintenance: revisit automation for Issues and PR's #133

saragerion opened this issue Jul 23, 2021 · 6 comments · Fixed by #1431 or #1437
Assignees
Labels
automation This item relates to automation completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Comments

@saragerion
Copy link
Contributor

saragerion commented Jul 23, 2021

Note, the body of this issue was edited to reflect the new scope:

  • If possible, when a new issue is created we should add it to the GitHub project (note, this is not a Project (classic) in GH nomenclature)
  • Review & make sure that when a new PR is opened, this job runs and if the PR body doesn't contain a string that matches this regex, which should be Issue number: #digits, the proper labels and comments are added to the PR.
  • Review & make sure that when this workflow runs and labels an issue as status/pending-release, it also removes the current status/* label as well as help-wanted (if present).
  • If possible, implement this workflow in this repo, with the difference that in our case it: 1/ queries all issues marked as status/pending-release (which should be all closed), 2/ removes the label, 3/ adds a label status/completed, 4/ leaves a comment that says the thing has been released (this last point is optional & not a must)
  • If possible, extend this workflow to label PRs with the correct areas based on title suffix and with the areas being the utilities only (i.e. area/logger, area/parameters, etc. - full list here)
  • If possible, implement a boring cyborg workflow that does this for Issues and this for PRs.
  • Consider renaming this workflow to remove V2 notation

Older issue body below, hidden for clarify/brevity and to reflect the new focus.

Description of the feature request

Problem statement

To keep up with our collaboration, for clarity, and make sure our efforts are tracked, there are 2 Github projects:
https://github.com/awslabs/aws-lambda-powertools-typescript/projects

  1. AWS Lambda Powertools Typescript - Issues https://github.com/awslabs/aws-lambda-powertools-typescript/projects/2
  2. AWS Lambda Powertools Typescript - Pull Requests https://github.com/awslabs/aws-lambda-powertools-typescript/projects/3
    All explanations of each column are added in the boards.
    While this structure is helpful, there is margin of improvement for how we can limit the manual effort to keep things tidy so that we understand what's going on.

Summary of the feature

Github related automation so that:

  • Newly created issues SHOULD be added to the Issues board;
  • Newly created issues / Issues that are in the "Needs clarification" column SHOULD NOT have assignees (because assignees = responsible to implement it);
  • Newly created issues SHOULD be created with the relevant labels, no assignees, correct projects assigned;
  • Issues that are in done done state should be automatically added in form of excerpt and references to the Changelog file and releases descriptions;

This can be achieved through relevant files/setup/configuration via Github actions or files in the .github folder.

Code examples

TBD.

Benefits for you and the wider AWS community

Automation of these tasks will allow maintainers and contributors to focus on the implementation of features rather than administration of tasks. Additionally, shifting the effort from human intervention to automation will reduce the rate of human errors.

Describe alternatives you've considered

Not at the moment.

Additional context

N/A.

Related issues, RFCs

@saragerion saragerion changed the title all: automation for Issue and PR's - assignment to relevant Github projects, labels, milestones, releases all: improve automation for Issues and PR's (Github projects, labels, milestones, releases, changelog) Jul 23, 2021
@saragerion saragerion added enhancement automation This item relates to automation labels Jul 23, 2021
@saragerion
Copy link
Contributor Author

@dreamorosi @bahrmichael @alan-churley keen to hear your perspective on this.
Note that this is not a priority (which is why I did not add it to the beta milestone).

@dreamorosi
Copy link
Contributor

Thank you Sara for the proposal, hard agree on the topic.

Regarding PRs we could leverage the same boring-cyborg that the Python repo uses; since a PR contains the path of the changes labelling it should be easy enough to automate.

Regarding issues, we could use an action like this one which should allow us to remove assignees, add labels, and move to a project.

@dreamorosi dreamorosi added this to the production-ready-release milestone Dec 10, 2021
@saragerion saragerion added the triage This item has not been triaged by a maintainer, please wait label Jan 5, 2022
@saragerion
Copy link
Contributor Author

As pointed out by @DanyC97, there is an opportunity for us to explore the new beta projects that are set at a github org level.

@saragerion saragerion removed this from the production-ready-release milestone May 16, 2022
@dreamorosi dreamorosi added discussing The issue needs to be discussed, elaborated, or refined internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) and removed triage This item has not been triaged by a maintainer, please wait enhancement labels Nov 13, 2022
@dreamorosi dreamorosi moved this from Backlog to Working on it in AWS Lambda Powertools for TypeScript Nov 13, 2022
@dreamorosi dreamorosi self-assigned this Nov 13, 2022
@dreamorosi dreamorosi changed the title all: improve automation for Issues and PR's (Github projects, labels, milestones, releases, changelog) Maintenance: improve automation for Issues and PR's (Github projects, labels, milestones, releases, changelog) Nov 14, 2022
@dreamorosi dreamorosi moved this from Working on it to Backlog in AWS Lambda Powertools for TypeScript Jan 10, 2023
@dreamorosi dreamorosi removed their assignment Feb 26, 2023
@dreamorosi dreamorosi changed the title Maintenance: improve automation for Issues and PR's (Github projects, labels, milestones, releases, changelog) Maintenance: revisit automation for Issues and PR's Feb 26, 2023
@dreamorosi
Copy link
Contributor

I have updated the body of the original post to reflect the current scope, after which we can consider the issue complete.

cc @am29d

@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed discussing The issue needs to be discussed, elaborated, or refined completed This item is complete and has been merged/shipped labels Feb 26, 2023
@dreamorosi dreamorosi added the confirmed The scope is clear, ready for implementation label Feb 26, 2023
@dreamorosi dreamorosi self-assigned this May 3, 2023
@dreamorosi dreamorosi moved this from Backlog to Working on it in AWS Lambda Powertools for TypeScript May 3, 2023
@dreamorosi dreamorosi linked a pull request May 3, 2023 that will close this issue
13 tasks
@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in AWS Lambda Powertools for TypeScript May 5, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 5, 2023

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed confirmed The scope is clear, ready for implementation labels May 5, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in AWS Lambda Powertools for TypeScript May 5, 2023
@dreamorosi dreamorosi reopened this May 5, 2023
@github-project-automation github-project-automation bot moved this from Shipped to Coming soon in AWS Lambda Powertools for TypeScript May 5, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 5, 2023

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed completed This item is complete and has been merged/shipped labels May 5, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in AWS Lambda Powertools for TypeScript May 8, 2023
@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels May 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation This item relates to automation completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
None yet
3 participants