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

all: run go generate during ci builds to check all files updated #2372

Merged
merged 1 commit into from Mar 9, 2020
Merged

all: run go generate during ci builds to check all files updated #2372

merged 1 commit into from Mar 9, 2020

Conversation

leighmcculloch
Copy link
Member

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

Run go generate during ci builds.

Why

We use go generate to trigger builds of our bindata files for SQL
migrations but we don't have any broad checks on CI that ensure that the
generated files are up to date. This ensures whenever we make a change
to an input file to code generation that the generated file is updated
in the same change/pull-request.

We achieve this to some degree in some apps, like Horizon, where we have
a test that checks that the generated data bytes match the bytes on
disk, but this is only in one app, requires us to write a test in each
app, and doesn't prevent diffs caused by environmental changes like us
upgrading the version of the go-bindata tool.

Known limitations

[TODO or N/A]

### What
Run `go generate` during ci builds.

### Why
We use `go generate` to trigger builds of our bindata files for SQL
migrations but we don't have any broad checks on CI that ensure that the
generated files are up to date. This ensures whenever we make a change
to an input file to code generation that the generated file is updated
in the same change/pull-request.

We achieve this to some degree in some apps, like Horizon, where we have
a test that checks that the generated data bytes match the bytes on
disk, but this is only in one app, requires us to write a test in each
app, and doesn't prevent diffs caused by environmental changes like us
upgrading the version of the go-bindata tool.
@leighmcculloch leighmcculloch requested a review from a team March 9, 2020 17:39
@cla-bot cla-bot bot added the cla: yes label Mar 9, 2020
@leighmcculloch leighmcculloch merged commit 99e8232 into stellar:master Mar 9, 2020
@leighmcculloch leighmcculloch deleted the gogenerate branch March 9, 2020 18:02
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.

None yet

2 participants