Skip to content

Commit

Permalink
docs: add info about decision to use github
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jan 13, 2025
1 parent da74661 commit 65300a2
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
47 changes: 47 additions & 0 deletions docs/decisions/0005-github.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Use Github as both our code repository & CI/CD

## Context and Problem Statement

We need somewhere to

- Store our code to work on it collaboratively.
- Raise issues and manage documentation around the code.
- Track development via roadmaps and task trackers.

We also need a pipeline runner (CI/CD):

- Create build artifacts for deployment.
- Run automated testing.
- Deploy our code into various development environments.

## Considered Options

- Github
- Gitlab
- Codeberg
- Bitbucket

## Decision Outcome

Github was originally chosen as it provided many benefits for free, over the
competition.

Cost and simplicity are key factors for us, being a small NGO that receives
project specific funding.

Since the decision was taken, Github was acquired by Microsoft and has
some practices that we do not agree with (license violations for Copilot,
amongst others).

Reluctantly, we are stuck with Github due to the migration effort that would
be required.

### Consequences

- Good, because free to use, including uncapped CI/CD usage as an NGO.
- Good, has the most visibility and reach of all other platforms.
- Bad, because as an organization it undertakes many practices we do not agree with.
- Bad, the more we use Github workflows (propriatary), the further we are
vendor-locked.
- Bad, because it would be difficult to migrate all of the accumulated issues,
milestones, project boards, subissues, etc.
1 change: 1 addition & 0 deletions docs/decisions/0006-slack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Use Slack to engage with our community members
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,8 @@ nav:
- Tech Decisions:
- React: decisions/0003-react.md
- Python: decisions/0004-python.md
- Github: decisions/0005-github.md
- Slack: decisions/0006-slack.md
- API Documentation: decisions/0002-mkdocs.md
- Technical Diagrams: decisions/0001-draw-io.md
- DevOps:
Expand Down

0 comments on commit 65300a2

Please sign in to comment.