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

Update & automate changelog #1160

Closed
12 tasks done
meritmalling opened this issue Jun 24, 2024 · 8 comments
Closed
12 tasks done

Update & automate changelog #1160

meritmalling opened this issue Jun 24, 2024 · 8 comments
Assignees

Comments

@meritmalling
Copy link
Contributor

meritmalling commented Jun 24, 2024

  • Get manual updates to change log up to date by AM 6/25/24
  • Refactor guides repo to accomadate automated updates triggered in other repos
  • Create change log package that can be reused on repos that release on tagged cadences
  • Add automations to the following repos that create a PR to the guides repo on release of a new version
    • flatfile-node (@flatfile/api)
    • flatfile-core-libraries (flatfile, @flatfile/listener, @flatfile/javascript, @flatfile/react, @flatfile/angular, @flatfile/vue)
    • flatfile-plugins (all)
      Iterations:
  • Update repos to trigger on release (instead of tag) and update for changelog 1.0.0
    • flatfile-node (@flatfile/api)
    • flatfile-core-libraries (flatfile, @flatfile/listener, @flatfile/javascript, @flatfile/react, @flatfile/angular, @flatfile/vue)
    • flatfile-plugins (all)
  • Spaces-UI and Dashboard automations
@meritmalling meritmalling self-assigned this Jun 24, 2024
@meritmalling
Copy link
Contributor Author

meritmalling commented Jun 25, 2024

WIP refactoring how the change log is structured in the guides repo.
This piece of work is needed to allow other automations to send easy, incremental updates & the guides repo will know how to handle them.

@meritmalling
Copy link
Contributor Author

@meritmalling
Copy link
Contributor Author

meritmalling commented Jun 27, 2024

Here's a lil sketch of the automation as it stands to go in. Just for this week I'm sure we can improve. Feedback very welcome @bangarang @NateFerrero!

Image

@meritmalling
Copy link
Contributor Author

meritmalling commented Jun 27, 2024

These two PRs on the guides repo should go in for a full e2e test:

#1161 (First action on guides in diagram)
#1168 (Second action on guides diagram)

When they go in I'll make and post a loom of the process!

TL:DR on process is that any repo with the changelog package installed/configured will, upon releasing a new package (eg @flatfile/react@8.0.0) will trigger these actions and create a PR in the guides repo. That PR still needs to be reviewed by a human before going in (we all agreed, cause hallucinations suck!) then it merged and goes live!

@meritmalling
Copy link
Contributor Author

meritmalling commented Jun 28, 2024

npm/cli#2610 Is unfortunately causing issues for e2e since these actions run in actions.

ToDos to fix:

  • Release package somewhere or use ssh credentials
  • Bundle to support cjs and es
  • Use github bot for release

@meritmalling
Copy link
Contributor Author

Apologies this slipped a day but everything is going out today!
Update:

  • Opening PRs to install on automations on the three repos mentioned above now
  • With ^^ installed changelog prs to guides will be automated.
  • They will require human review/approval to merge but that's a deliberate decision and the turnaround on those will be very short.

Remaining automation:

  • Front end (spaces, dash) automation -> we'll need a slight modification for these untagged updates

@meritmalling
Copy link
Contributor Author

Home stretch, just need someone with permission to add environment variables to these prs and approve.
Once merged automation on tagged releases should be completed!

FlatFilers/flatfile-plugins#549
FlatFilers/flatfile-core-libraries#140
FlatFilers/flatfile-node#47

@meritmalling
Copy link
Contributor Author

Major release of changelog package to accommodate using commit diffs as well as tags went in, so we're on changelog 1.0.0 now.

Updates to tagged repos:

FlatFilers/flatfile-node#49
FlatFilers/flatfile-plugins#558
FlatFilers/flatfile-core-libraries#152

And PR for spaces-ui and dashboard automation:

https://github.com/FlatFilers/Platform/pull/7779

That's everything for basic functionality!

I'll be updating the https://github.com/FlatFilers/changelog repo will issues for next steps - we're going to make a slack channel to notify all contributors with easy actions they can take to approve, edit, dismiss the summaries.

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

No branches or pull requests

2 participants