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

Review README #270

Merged
merged 3 commits into from
Jun 10, 2022
Merged

Review README #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9fcc19
docs: [#67] add missing workflow budgets
josecelano Jun 9, 2022
52f1c8b
docs: [#67] fix dead link in docs
josecelano Jun 9, 2022
8766771
docs: [#67] fix grammar
cgbosse Jun 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Git Queue

<!-- markdownlint-disable-next-line MD013 -->
[![Check dist/](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/check-dist.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/check-dist.yml) [![MegaLinter](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/mega-linter.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/mega-linter.yml) [![Test](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/test.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/test.yml) [![Test build](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/test-build.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/test-build.yml)
[![Check dist/](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/check-dist.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/check-dist.yml) [![MegaLinter](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/mega-linter.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/mega-linter.yml) [![Test](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/test.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/test.yml) [![Test build](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/test-build.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/test-build.yml) [![CodeQL](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/codeql.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/codeql.yml) [![Deploy Documentation](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/deploy-documentation.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/deploy-documentation.yml) [![Publish GitHub Release](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/publish-github-release.yml/badge.svg)](https://github.com/Nautilus-Cyberneering/git-queue/actions/workflows/publish-github-release.yml)
josecelano marked this conversation as resolved.
Show resolved Hide resolved

Documentation: <https://nautilus-cyberneering.github.io/git-queue/>

This GitHub Action is a job queue with the following characteristics:

- It only allows the execution of a job at the same time. Multiple pending jobs is allowed.
- It only allows the execution of one job at a time. Multiple pending jobs are allowed.
- Jobs are done by GitHub workflows intended to create git commits and merge them into target branches.
- It provides an optimistic locking mechanism to guarantee that commits are merged in a mutual exclusion way, avoiding duplicate commits. When the queue accepts more than one active job (not finished) it will also guarantee the execution order.

Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Make sure commits keep their signatures.
## Update node dependencies

- Dependencies updates should be in an independent branch, as any other code modification.
- We are reusing always the same [issue](https://github.com/Nautilus-Cyberneering/git-queue/issues/183) and the same [branch name](https://github.com/Nautilus-Cyberneering/git-queue/tree/issue-183-update-node-depdencies) for dependencies update. That way we have a dependency update history (issue) and a consistent updates branch that can be used for automation.
- We are reusing always the same [issue](https://github.com/Nautilus-Cyberneering/git-queue/issues/183) and the same branch name(`issue-183-update-node-dependencies`) for dependencies update. That way we have a dependency update history (issue) and a consistent updates branch that can be used for automation.
- If a dependency breaks the code (i.e, does not compile or the tests do not pass), it should be solved in a separate, specific issue.

Given everything, the process of dependencies updates would be as follows:
Expand Down