ai-cfia / ai-cfia/github-workflows

As a Devops, handle consistent version management across our projects

Aperta
#79 0 commenti 0 reazioni 1 assegnatario Assegnata a @ThomasCardin Vedi su GitHub
epic
Lingua principale
Nessun dato sulla lingua
Stelle
2
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## Background:
We've noticed instances in our codebase where versions are unintentionally decreased or inconsistent across different configuration files. This has led to issues in our deployment and build processes, affecting the overall reliability of our projects.

## Objective:
To ensure consistency and correctness in version management across our projects (Flask / React). Specifically, we want to enforce that:

1. Versions are consistently incremented in pull requests.
2. Versions in specific configuration files (like _versions.ts in TypeScript projects) match the corresponding version in the primary package management file (e.g., package.json).

## Current Workflows:
We already have specific reusable workflows for React and Flask (Python) projects focusing on linting and testing. However, these do not include checks for version consistency. We also have databases with no current workflow to handle versioning.

## Proposed Solution:

- Integrate version consistency checks into our existing reusable workflows for React and Flask projects as well as our databases solutions. This integration should include:
- Version Increment Check: Ensure that the version in a PR is incremented compared to the main branch.
Cross-file Version Consistency: In TypeScript projects, for instance, ensure that the version in _versions.ts matches the version in package.json.

## Related Open Issues:
This issue is an extension and generalization of specific concerns raised in our project repositories:
- https://github.com/ai-cfia/github-workflows/issues/65
- https://github.com/ai-cfia/finesse-frontend/issues/48

### Todo
- Create issue for Flask consistent version management
- Create issue for databases consistent version management

## Action Items:
- [ ] : Research & Design: Investigate the best methods to implement these checks in our existing workflows.
- [ ] : Implementation: Update the reusable workflows for each stack with the new version consistency checks.
- [ ] : Documentation: Update our workflow documentation to include these new version consistency checks.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.