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.

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

Rename and export specs #3245

Merged
merged 11 commits into from
Jan 13, 2023
Merged

Rename and export specs #3245

merged 11 commits into from
Jan 13, 2023

Conversation

teodanciu
Copy link
Contributor

@teodanciu teodanciu commented Jan 11, 2023

Description

  • Renames generated specs in a more consistent way.
  • Removes a bak file that I assume was added by accident
  • Adds a github action that:
    • gets triggered when a tag is pushed that has name: cardano-ledger-specs-[0-9]+-[0-9]+-[0-9]+ (for example: cardano-ledger-specs-1.0.0)
    • creates a release for this tag, and attaches to the release the corresponding specs, as generated by nix-build -A specs
  • Update the links the specs from the dangling hydra ones to the latest github release ones

For an example of how the releases with the attached docs look, you can see my fork here:
releases: https://github.com/bienpulenta/cardano-ledger/releases and
actions that created these releases: https://github.com/bienpulenta/cardano-ledger/actions

(I used this repo as a test, in order to not create releases on our main repo)
Closes #2810

Checklist

  • Commit sequence broadly makes sense
  • Commits have useful messages
  • New tests are added if needed and existing tests are updated
  • Any changes are noted in the changelog
  • Code is formatted with fourmolu (which can be run with scripts/fourmolize.sh
  • Self-reviewed the diff

@teodanciu teodanciu changed the title Td/rename and export specs Rename and export specs Jan 11, 2023
@teodanciu teodanciu marked this pull request as ready for review January 11, 2023 15:36
@teodanciu teodanciu requested a review from a team as a code owner January 11, 2023 15:36
Copy link
Contributor

@JaredCorduan JaredCorduan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is wonderful, thank you @teodanciu ! great catch on that bak file.

@teodanciu teodanciu merged commit 7bb0993 into master Jan 13, 2023
@iohk-bors iohk-bors bot deleted the td/rename-and-export-specs branch January 13, 2023 08:53
iohk-bors bot added a commit to IntersectMBO/cardano-node that referenced this pull request Feb 13, 2023
4775: Markdown links CI check r=newhoggy a=newhoggy

This adds a CI check to make sure Markdown links are valid.

There are currently failures in this CI check, but the idea is to merge the PR as is and then ask the respective teams to fix the invalid links.

Depends on:
* input-output-hk/cicero#67
*  IntersectMBO/cardano-ledger#3245
* input-output-hk/cicero#67

Co-authored-by: John Ky <john.ky@iohk.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Version the formal specs
3 participants