Skip to content

bastean/x

Repository files navigation

README Logo


License MIT Commitizen friendly Release It! GitHub Releases

Upgrade workflow CI workflow Release workflow Summary workflow

Module Reference Status Latest
tools Go Reference Go Report Card Version

Workflow

Important

To add or remove a module within go.work, we must use the following tasks to synchronize the workflow of release.yml with the new changes in the workspace.

Add new module to workspace

task work-use-"<module>"

Remove module from workspace

Warning

This task will also delete the specified module folder.

task work-drop-"<module>"

...v0 > <module>/dev0.1.0 > ci/<module>/dev0.1.0 > main > v0...

Create v0 branch from main.

task git-v0

Create module development branch <module>/dev0.1.0 from main.

task git-"<module>"-dev0.1.0

Create branch ci/<module>/dev0.1.0 from <module>/dev0.1.0 to ensure that the workflows run correctly with the new changes before merging them with main.

task git-ci/"<module>"/dev0.1.0

Once the workflows have been successfully passed, the new changes from ci/<module>/dev0.1.0 will be merged into main.

task git-main-ci/"<module>"/dev0.1.0

After releasing the new version <module>/v0.1.0, the main and v0 branches in our local repository will be updated.

task git-pull-v0

To end the cycle, the <module>/dev0.1.0 and ci/<module>/dev0.1.0 branches will be deleted.

task git-cleanup-"<module>"/dev0.1.0

First Steps

Clone

HTTPS

git clone https://github.com/bastean/x.git && cd x

SSH

git clone [email protected]:bastean/x.git && cd x

Initialize

Locally

  1. System Requirements

  2. Run

    task init

Run

Tests

Unit (Single-Module)
cd <module> && task test-unit
Unit (Multi-Module)
task test-units
Integration (Single-Module)
cd <module> && task test-integration
Integration (Multi-Module)
task test-integrations
Acceptance (Single-Module)
cd <module> && task test-acceptance
Acceptance (Multi-Module)
task test-acceptances
Unit / Integration / Acceptance (Multi-Module)
task tests

Tech Stack

Base

Please see

Contributing

Contributions and Feedback are always welcome!

License

MIT