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

Docs: document CI/CD behavior / implementation #1038

Closed
dreamorosi opened this issue Aug 3, 2022 · 2 comments
Closed

Docs: document CI/CD behavior / implementation #1038

dreamorosi opened this issue Aug 3, 2022 · 2 comments
Assignees
Labels
confirmed The scope is clear, ready for implementation documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Comments

@dreamorosi
Copy link
Contributor

Description of the improvement

Summary of the proposal
With the number of workflows and scripts growing in our CI/CD processes (based on GitHub Actions) there's a need of documenting the relationships between each workflow/script and also the different triggers.

The proposal is to create a .github/workflows/README.md file and have a short explanation + diagram of each major workflow, similar to what done in this comment of #1023.

How, where did you look for information
N/A

Missing or unclear documentation
.github/workflows/README.md

Improvement
Creating the doc would help all existing maintainers to have context on how the workflows. This would also be useful to onboard additional maintainers / collaborators in the future.

Related existing documentation

N/A

Related issues, RFCs

#1023

@dreamorosi dreamorosi added documentation Improvements or additions to documentation good-first-issue Something that is suitable for those who want to start contributing triage This item has not been triaged by a maintainer, please wait github_actions labels Aug 3, 2022
@dreamorosi dreamorosi removed the triage This item has not been triaged by a maintainer, please wait label Aug 24, 2022
@dreamorosi dreamorosi self-assigned this Aug 24, 2022
@dreamorosi dreamorosi removed the good-first-issue Something that is suitable for those who want to start contributing label Oct 27, 2022
@dreamorosi dreamorosi added internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) confirmed The scope is clear, ready for implementation and removed github_actions labels Nov 13, 2022
@dreamorosi dreamorosi changed the title Documentation (build): document CI/CD behavior / implementation Docs: document CI/CD behavior / implementation Nov 14, 2022
@dreamorosi
Copy link
Contributor Author

Most of the automation has now been documented in the Processes section of the documentation as well as the Maintainers handbook. Additionally, each workflow has now a mini documentation at the top of the file that explains how it works and its purpose.

We also have a couple dedicated issues that should be addressed during the next few iterations:

With this in mind, I'll be closing this issue as completed.

@github-project-automation github-project-automation bot moved this from Backlog to Coming soon in Powertools for AWS Lambda (TypeScript) Feb 21, 2024
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Feb 21, 2024
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed The scope is clear, ready for implementation documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
Development

No branches or pull requests

1 participant