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(workflow): adds a description at the top of each file #8009

Merged
merged 5 commits into from
Dec 12, 2023

Conversation

gustavovalverde
Copy link
Member

@gustavovalverde gustavovalverde commented Nov 27, 2023

Motivation

It's better if member of the team, existing or new contributors, can understand what a workflow file is meant to do (overall) before deep diving into it and trying to understand it piece by piece.

Closes #7607
Depends-On: #8009

PR Author Checklist

Check before marking the PR as ready for review:

  • Will the PR name make sense to users?
  • Does the PR have a priority label?
  • Have you added or updated tests?
  • Is the documentation up to date?
For significant changes:
  • Is there a summary in the CHANGELOG?
  • Can these changes be split into multiple PRs?

If a checkbox isn't relevant to the PR, mark it as done.

Solution

  • Explain the workflow objective
  • Explain some of the steps taken in the workflow, to accomplish the objetive

Review

This PR depends on changes on the scrips, so I didn't had to make these changes twice.

Reviewer Checklist

Check before approving the PR:

  • Does the PR scope match the ticket?
  • Are there enough tests to make sure it works? Do the tests cover the PR motivation?
  • Are all the PR blockers dealt with?
    PR blockers can be dealt with in new tickets or PRs.

And check the PR Author checklist is complete.

Follow Up Work

None

@gustavovalverde gustavovalverde added A-docs Area: Documentation A-devops Area: Pipelines, CI/CD and Dockerfiles P-Low ❄️ I-usability Zebra is hard to understand or use C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG labels Nov 27, 2023
@gustavovalverde gustavovalverde self-assigned this Nov 27, 2023
@gustavovalverde gustavovalverde requested a review from a team as a code owner November 27, 2023 20:22
@gustavovalverde gustavovalverde requested review from upbqdn and removed request for a team November 27, 2023 20:22
@teor2345
Copy link
Contributor

Conflicting files
.github/workflows/cd-deploy-nodes-gcp.yml
.github/workflows/ci-integration-tests-gcp.yml
.github/workflows/ci-unit-tests-docker.yml
.github/workflows/docs-deploy-firebase.yml

Ah, sorry about that, I added descriptions as part of the external repository patch PRs, because it was starting to get really confusing.

@mpguerra mpguerra linked an issue Dec 4, 2023 that may be closed by this pull request
.github/workflows/ci-build-crates.yml Outdated Show resolved Hide resolved
@teor2345
Copy link
Contributor

teor2345 commented Dec 5, 2023

I think there are bugs in this branch that are fixed in the base PR, so I just updated it.

@teor2345
Copy link
Contributor

teor2345 commented Dec 5, 2023

Ah, that doesn't seem to work, maybe the bugs are still in the base PR.

@arya2 arya2 added the do-not-merge Tells Mergify not to merge this PR label Dec 11, 2023
@teor2345 teor2345 removed the do-not-merge Tells Mergify not to merge this PR label Dec 12, 2023
@upbqdn upbqdn merged commit 4978352 into ref-workflow-scripts Dec 12, 2023
149 checks passed
@upbqdn upbqdn deleted the add-workflow-description branch December 12, 2023 11:59
mergify bot pushed a commit that referenced this pull request Dec 12, 2023
* ref(workflow): move most scripts to their own executable

* debug: JSON value

* fix(scripts): move remaining script to its own file

* fix(script): revert to the correct disk search logic

* fix(scripts)

* fix(scripts): use correct NETWORK with lowercase

* fix: typo

* fix(script): wrong variable assignment

* fix(script): use correct return values inside a function

* fix(script): fix value assigment

* test: debug

* fix(script): make disk conditions simpler

* fix(script): export variables to the `shell` executing the script

* fix(script): do not fail on expected unbound variables

* test: output

* fix(scripts): do not `echo` a variable more than once

* fix(scripts): typo

* docs(workflow): adds a description at the top of each file (#8009)

Co-authored-by: Marek <[email protected]>
Co-authored-by: teor <[email protected]>

---------

Co-authored-by: teor <[email protected]>
Co-authored-by: Alfredo Garcia <[email protected]>
Co-authored-by: Marek <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-docs Area: Documentation C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG I-usability Zebra is hard to understand or use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add short descriptions at the top of the workflow files
4 participants