Commit Graph

155 Commits

Author SHA1 Message Date
Daniel Lockyer
32b325eb4c Added codecov.io coverage uploader to CI
refs linear.app/tryghost/issue/CORE-74/improve-the-test-situation

- this commit adds the codecov GitHub Action into CI so we can upload
  coverage reports
- the coverage files need to be in XML for them to work with
  codecov, so this commit also adds cobertura (XML) as a reporter
2021-10-20 15:12:07 +02:00
Hannah Wolfe
bcf19c8fe2
Fixed CI not running integration tests
refs: 726db1c0e

- I totally forgot/missed that we run each test suite individually on CI, rather than using `yarn test:all`
2021-10-14 12:24:16 +01:00
Hannah Wolfe
1dec3d56b1
Renamed our acceptance tests to "e2e"
- These are end-to-end tests, make it clearer what they are and what they are supposed to do
2021-10-06 12:40:52 +01:00
Daniel Lockyer
0d5b836557
Added RELEASE_NOTIFICATION_URL secret to release workflow
refs https://linear.app/tryghost/issue/CORE-38/automate-releases

- this is a notification endpoint which we pass down to the
  `action-ghost-release` GitHub Action to create notifications when the
  release is done
2021-09-28 16:45:30 +01:00
Daniel Lockyer
99d601bc9f
Moved GITHUB_TOKEN env variable to workflow scope
no issue

- the CLI install extension step also needs the token so it's just best
  to include it globally in the workflow
2021-09-09 09:49:08 +01:00
Daniel Lockyer
d897942af7
Added auto-assign workflow to pull requests
no issue

- Renovate will open PRs to bump dependencies but these are unassigned
- Renovate does have the ability to set assignees, but these are blanket
  assigns not based upon the package that is being upgraded
- we want to assign them to the owners of the package that is being
  upgraded
- I've created the `gh-auto-assign` GitHub CLI exntension which reads a
  `.github/AUTO_ASSIGN` file and assign PRs based upon the entries listed
- this commit adds the initial `AUTO_ASSIGN` file and GitHub Actions
  workflow to trigger when a PR is opened
2021-09-08 10:12:31 +01:00
Daniel Lockyer
c7f45f5580 Renamed coverage:unit command to cov:unit
no issue

- this is slightly quicker to type and cleaner to read
2021-08-26 15:06:45 +02:00
Daniel Lockyer
70bea3ddf8 Added c8 coverage to unit tests
no issue

- coverage allows us to see how much of our code we're hitting in tests
  and it's time we started to get visibility on this in Ghost
- we can then make informed decisions on which well-tested internal libraries
  can be pulled out into their own packages
- this commit:
  - adds the c8 dev dependency to Ghost
  - prepends the `test:unit` command with c8 with the `text-summary` reporter
  - adds a `coverage:unit` command to get the `text` report
    - you can do `yarn coverage:unit --reporter html` to get a HTML report etc
  - uses this new test coverage reporter command in CI tests
2021-08-20 12:42:11 +02:00
Daniel Lockyer
fe3355276f
Included v4.* branches in CI testing
no issue

- as we're making more and more use of branches for releases, we want
  tests to run on them
- this commit adds the v4 wildcard to the GitHub workflow so it'll
  trigger when we push to them
2021-07-22 15:21:36 +01:00
Daniel Lockyer
7fe943bb49
Updated CI release workflow to use built-in token
no issue

- `RELEASE_TOKEN` is currently a GitHub personal token, but this
  has some downsides:
    - if the token ever expires and I'm unaware, it'll break the release
      process
    - GitHub Releases say the creator was `daniellockyer` even if someone
      else actually did the release
- this commit switches over to using the built-in `GITHUB_TOKEN`, which
  is owned by the `github-actions` app and should never expire
- aside from that, Ghost releases will be created by the neutral
  `github-actions` account
2021-07-12 13:14:55 +01:00
Daniel Lockyer
6eba445f23
Fixed canary build after yarn command changes
refs 7e6800b2b8

- referenced commit deprecated `grunt main` in favor of `yarn main` but
  this wasn't updated so we never installed dependencies for Admin,
  which caused the build to break
- this commit switches to the new command
2021-07-06 10:22:07 +01:00
Hannah Wolfe
7e6800b2b8
Improved dev tooling (#13118)
This commit achieves a few things:

- ☑️  No longer having to remember whether a command is yarn something or grunt something
- ☑️  Simplification of tools hopefully making them easier to remember and use 
- ☑️  Complete removal of the need for grunt from our test tooling

Several of the tools still use grunt under the hood, but the **entrypoint** should aways be `yarn xxx`.

- `grunt main` -> `yarn main`
- `grunt dev` -> `yarn dev`
- `grunt build` -> `yarn build`
- `grunt test:file-or-folder` -> `yarn test file-or-folder`
- `grunt test-unit` -> `yarn test:unit`
- `grunt test-acceptance` -> `yarn test:acceptance`
- `grunt test-regression` -> `yarn test:regression`
- `grunt validate` -> removed due to lack of use

There is now also `yarn test:all` to run all 3 classes of tests

This PR also reorders & restructures the Gruntfile extensively so that:

- The remaining useful commands are all at the top of the file
- Config and other blah happens after all the useful commands
- All release-only config happens in the release task at the very end of the file

---

DONE:

* Removed all references to npm/bower
* Removed all references to lint / deprecated command
* Moved debug to yarn dev:debug
* Removed all references to travis
* Removed broken help task + useless comment
* Removed unused knex-migrator and clean:test setup tasks
* Added new test commands, removed grunt validate
* Moved stubClientFiles to test utility and use in the few tests that need it
* Used mocha in yarn directly except grunt test:x
* Swapped grunt test for yarn test
* extensive cleanup and reshuffling
2021-07-05 20:02:22 +01:00
Daniel Lockyer
d25b8680f4
Added CI step to print debug logs upon CLI failure
no issue

- if Ghost-CLI tests fail, the CLI will put some extra debug logs in
  `~/.ghost/logs`
- these are useful to help see what the issue is, so we should print
  them out if we're experiencing a failure
- this commit cats the contents of the folder so we can see it in CI
2021-06-09 13:51:55 +01:00
Daniel Lockyer
84bfbae282
Extracted canary build to separate workflow
no issue

- by extracting it to a different workflow that uses the
  `workflow_dispatch` trigger, we can manually run a build, but also
  trigger it from Admin so we can always stay up-to-date
2021-06-01 17:04:16 +01:00
Daniel Lockyer
bbeeb83235
Updated Canary builds to use preminor versioning
no issue

- we want to use `preminor` so it'll run migrations for the unreleased
  version if they are present
2021-05-21 16:40:06 +01:00
Daniel Lockyer
28f125926c
Updated release workflow to use Node 14
no issue

- Node 14 is now our recommended version and it's easier if we build
  Ghost with this version
- this also works around the fact that 12.18.0 would no longer build
  Ghost because we have bumped our minimum 12 version
2021-05-10 20:41:38 +01:00
Daniel Lockyer
4385070881
⬆️ Bumped minimum Node version to 12.22.1 and 14.16.1
refs https://nodejs.org/en/blog/vulnerability/april-2021-security-releases/

- these are the latest security releases and we should encourage people
  to upgrade to them
- also replaces Node 12 in the tests with Node 14 as this is soon our
  recommended version
2021-05-07 14:14:46 +01:00
Daniel Lockyer
7360be5625
Disabled Ghost v1 and v2 CLI tests
refs 57ff38da8a

- we're dropping support for Node 10 which involved bumping the Node
  version we run our Ghost-CLI tests on but they fail because Ghost v1
  and v2 don't support Node 12
- this commit disables these tests until we come up with a good
  workaround
2021-05-05 14:59:20 +01:00
Daniel Lockyer
57ff38da8a
🔥 Dropped support for Node 10
refs https://github.com/TryGhost/Team/issues/658

- Node 10 become EOL as of April 30th so it's time to drop support
- this commit:
  - removes the Node 10 range from the `node` `engines` block
  - removes Node 10 from CI tests
  - switches Node 10 in the CLI test to Node 12 so we can ensure it
    installs on our oldest supported Node version
2021-05-05 14:38:14 +01:00
Hannah Wolfe
cc736a3eef
Update CONTRIBUTING.md 2021-04-20 15:44:18 +01:00
Hannah Wolfe
f247f6b3ef
Update ---bug-report.md 2021-04-13 10:53:36 +01:00
Hannah Wolfe
c99dc2f0bc
Update ---bug-report.md 2021-04-07 08:57:20 +01:00
Matthew Schmoyer
4b0a990a75
Update contributing docs to reference main branch (#12815)
no issue
2021-03-25 11:05:14 +00:00
Daniel Lockyer
35e45dbe7b
Added CI check to test updates from v3
no issue

- now we've officially released v4, we need to check updates from v3
- this commit adds a test copied from the other tests above
- also renames the steps from Upgrade to Update to match internal terminology
2021-03-17 11:52:26 +00:00
Daniel Lockyer
1155a3cd5d
Removed Casper-specific 4.0 code from CI
no issue

- the 4.0 Casper work is now in `main` and we don't need to switch
  branches any more
2021-03-10 21:49:02 +00:00
Daniel Lockyer
dc8e6be9fe
Updated canary workflow to use Casper 4.0 branch
no issue

- when building the canary zip, we currently use `main` within Casper,
  but the 4.0 changes are on the 4.0 branch
- this commit updates the workflow to checkout that branch as part of
  the pipeline
2021-03-09 08:48:59 +00:00
Daniel Lockyer
a39f15c196 Switched CI to using v4 Casper
no issue

- some new GScan changes mean that CI now throws a warning when using v3
  Casper, which causes tests to fail
- we need to switch to v4 to get the tests to pass
- we can't put v4 Casper in `main` because it'll autodeploy and be
  unusable for anyone downloading until Ghost 4.0 is released
2021-03-01 10:53:18 +00:00
Daniel Lockyer
26c49b4f57 Updated SQLite path for CI tests
- turns out GitHub Actions doesn't have /tmp as a tmpfs, so this commit
  switches to using /dev/shm, which *should* work ok
2021-02-23 16:58:31 +00:00
Daniel Lockyer
5a758ea86e Re-enabled Ghost-CLI upgrade tests
no issue

- now GScan has been updated to support v4, we should be able to run these tests again
2021-02-09 17:13:55 +00:00
Daniel Lockyer
3e39239af0
Updated actions/setup-node to v2
no issue

- amongst many other things, v2 uses a cache to download Node versions
2021-02-09 16:21:54 +00:00
Daniel Lockyer
d9a7fb0677
Fixed versioning for canary builds
no issue

- premajor will build a 5.0.0 prerelease but we want a 4.0.0 prerelease
  built
2021-02-03 09:29:04 +00:00
Daniel Lockyer
a2d97de09a
Updated test workflow to reflect branch renames
no issue

- 4.x has been renamed to main, which is now the default
- `master` is now 3.x, which is on a different set of workflows anyway
2021-02-02 18:04:38 +00:00
Daniel Lockyer
bf163bf058
Commented out select Ghost-CLI tests
no issue

- Ghost-CLI uses gscan under the hood to check the theme, but GScan has
  not yet been updated to support v4
- disabling these tests for now until it does
2021-02-02 17:21:56 +00:00
Daniel Lockyer
fb26e3d892
Updated migrations test to rollback to different versions
no issue

- in 4.0, we don't expect to rollback to 3.0 because there are
  irreversible migrations
- the existing test attempts to do this because it was written for v3
- this commit updates the test to apply to v4, although this will need
  to change soon when we switch branches
2021-02-02 16:12:54 +00:00
Daniel Lockyer
032741a5ef
Enabled tests and canary build on 4.0 branch
no issue

- we want tests to run on the 4.0 branch, along with Slack notifications
- we also want a canary build of the 4.0 branch, but this requires some
  alterations to bump to a premajor + use a different artifact name
2021-01-21 11:36:41 +00:00
Daniel Lockyer
ff11b42c33
Inlined canary build workflow into tests
- this allows us to rely on successful test steps before building a
  canary zip
2021-01-19 12:11:34 +00:00
Renovate Bot
1b0a8f5fbf Update actions/setup-node action to v2 2021-01-04 08:56:33 +00:00
Daniel Lockyer
fc9e107254 Revert "Bumped Node version used for Ghost-CLI tests"
- this reverts commit a43f4dc4de
- we can't use Node 12 here because Ghost v1 doesn't support it...
2020-11-23 11:22:23 +00:00
Daniel Lockyer
a43f4dc4de Bumped Node version used for Ghost-CLI tests
- our recommended version is Node 12 so we should use this
- possibly also solves some random CI failures we were seeing with
  sqlite3 not installing?
2020-11-23 11:18:48 +00:00
Daniel Lockyer
736c96439b Increased sleep delay before killing Ghost in CI tests
- We'd randomly see SQLite take more than 10 seconds to set up the DB in
  CI so Ghost was getting killed prematurely, causing test failures
2020-11-20 08:41:59 +00:00
Daniel Lockyer
6b8bfb81fc Fixed canary build on release commits
- because the Admin submodule has been updated, there aren't any
  differences that can be committed so we shouldn't do it
- this should check if we have uncommitted changes and only commit if so
2020-11-17 14:23:44 +00:00
Daniel Lockyer
249c4a3e83 Enabled cloning of submodules in migrations test
- we start Ghost in this test but Ghost will check Casper, which isn't
  cloned without this commit
2020-11-17 09:16:03 +00:00
Daniel Lockyer
7640fa3bee Revert "Bumped CI rollback version to 3.30"
- this reverts commit d22bbf58c7
- the issue with a migration was actually valid and we've fixed it
2020-11-11 11:59:02 +00:00
Daniel Lockyer
d22bbf58c7 Bumped CI rollback version to 3.30 2020-11-11 11:12:21 +00:00
Daniel Lockyer
d67683d7e6 Switched to running Ghost in CI migration tests
- if we only run 'knex-migrator init', the settings don't get populated like
  they would when running Ghost
- switching to running Ghost for initialization is more realistic of
  what would happen IRL
2020-11-11 10:42:13 +00:00
Daniel Lockyer
36fb04f735 Renamed workflow to Canary
- makes more sense than "zip"
2020-11-10 11:03:54 +00:00
Daniel Lockyer
361d79a8ef Added CI workflow for testing migrations
- initializes the DB, rolls back to v3.0 and then forward to the latest again
2020-11-06 13:33:39 +00:00
Daniel Lockyer
489add6e5e Pinned Node version in CI
- The default Node version on GitHub Actions is moving to Node 14 and we
  want to keep building it on 12 for now, so this commit pins the
  version to 12.18.0
2020-11-02 08:48:05 +00:00
Daniel Lockyer
b8c9ef5033 Added temporary second artifact upload
- we're changing the name but need to maintain compatibility until the
  new setup is live
2020-10-29 13:18:45 +00:00
Daniel Lockyer
52bac88136 Added Ghost & Ghost-Admin commit hashes into version
- this will generate zips with the hashes already included, and avoid
  the crazy bash further in the script
2020-10-29 12:08:16 +00:00