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

GitHub Action Review - Consistent Naming Conventions - Coverage Gaps #639

Closed
Thels opened this issue Nov 30, 2024 · 1 comment
Closed

GitHub Action Review - Consistent Naming Conventions - Coverage Gaps #639

Thels opened this issue Nov 30, 2024 · 1 comment
Assignees
@Thels
Labels
chore documentation Improvements or additions to documentation Refactor
Milestone
1.0

Comments

@Thels
Copy link
Member

Thels commented Nov 30, 2024

Feature Request

Description of Problem:

There are a number of Github actions within the project - however they are needing a minor touch up;

  • Naming convention of the actions don't always align - like between how Shared and CLI are built.
  • Some actions are missing like build-time checking of the docs module.

Solution:

  1. Introduce consistent naming and document these standards within the root level README.md.
  2. Ensure if we rename any files/jobs that the root level README.md URL's are updated for the status badges.
  3. Identify ( and document on this issue ) any missing Github actions, implementing them if it isn't too much effort.
@Thels Thels added documentation Improvements or additions to documentation Refactor labels Nov 30, 2024
@Thels Thels added this to the 1.0 milestone Nov 30, 2024
@Thels Thels self-assigned this Nov 30, 2024
@Thels Thels added the chore label Dec 3, 2024
@Thels
Copy link
Member Author

Thels commented Dec 3, 2024

I think it's a little out of the scope of this chore issue - but from looking at other projects in the real world - they tend to use a github action around https://github.com/release-drafter/release-drafter - which uses the content of our commits to govern version changes so that we don't need to bother. What do folks think?

Thels added a commit to Thels/architecture-as-code that referenced this issue Dec 3, 2024
@Thels
chore: fixes finos#639
75ff02c
rocketstack-matt added a commit that referenced this issue Dec 3, 2024
@YoofiTT96 @Thels
@renovate @rocketstack-matt @willosborne @djohnston89
Update explore-cytoscape with changes from main (#648)
514d9a9 
* CLI Version Upgrade
Also fixing the CLI by;
Introducing `tsup` to bundle our packages together into a useable executable.
Migrated `spectral` into `shared` - updated README and steps - now the steps aren't referenced via file and are part of the code itself. Simplfying validation code.

* Cleaned up Spectral from CODEOWNERS

* Update dependency ts-graphviz to v2.1.5 (#629)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Missing package-lock.json (#631)

* Update docusaurus monorepo to v3.6.2 (#605)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Matthew Bain <[email protected]>

* Update dependency @types/node to v22.10.1 (#635)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Update docusaurus monorepo to v3.6.3 (#633)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* This fixes #316 (#634)

Introducing a `-pretty` flag to the validate command.

* #486 Unify instantiation mechanisms (#521)

* add instantiate module and move relationships/metadata to use it

* #486 initial unification

* #486 add path context to generate command logging

* #486 fix condition when instantiating

* 486 clean up functions and split property instantiation

* #486 lint

* #486 always instantiate 'interfaces' block

* 486 test improvements

* #486 comments cleanup

* #486 test improvements

* Workspace Bin Movement

Now that I know more about workspaces, the published CLI didn't have a bin element so wasn't being linked as part of the release/install.

Also ran lint-fix - so some other line ending fixes.

* Instantiate refs and qualify relative paths when generating

* Extract update logic to higher-order function

* Add schema directory test for qualifying refs

* Properly instantiate enums (first cut)

* Fix typing issue and enum placeholder logic

* Log potential values for an enum when instantiated

* Suggested change to appendPath

* Lint

---------

Co-authored-by: Thels <[email protected]>

* #639 - Github Action Chore - Standardizing Existing - Introducing Docs Build for PRs (#643)

* chore: fixes #639

* Code review fixes

---------

Co-authored-by: Matthew Bain <[email protected]>

* Update docs url to new domain (#644)

* Update dependency globals to v15.13.0 (#641)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Update typescript-eslint monorepo to v8.17.0 (#602)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

---------

Co-authored-by: Thels <[email protected]>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Matthew Bain <[email protected]>
Co-authored-by: Will Osborne <[email protected]>
Co-authored-by: David Johnston <[email protected]>
rocketstack-matt added a commit to rocketstack-matt/architecture-as-code that referenced this issue Dec 5, 2024
@Thels @rocketstack-matt
finos#639 - Github Action Chore - Standardizing Existing - Introducin…
917aafc 
…g Docs Build for PRs (finos#643)

* chore: fixes finos#639

* Code review fixes

---------

Co-authored-by: Matthew Bain <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Thels Thels

Labels
chore documentation Improvements or additions to documentation Refactor
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
1 participant
@Thels