diff --git a/README.md b/README.md index f147b47..e363f61 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # Git Queue -[![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) Documentation: 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. diff --git a/docs/development.md b/docs/development.md index b551e80..362ca5d 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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: