Version 0.25.0: Rework CI and Contributions #90

Samasaur1 · 2020-10-31T17:08:50Z

Here's what's new:

Improves PR template & guidelines
Runs GitHub Actions testing on all branches & PRs
Make Travis run documentation deployment (on tags) and Danger (on PRs)
Danger checks that the version is updated, and that there is a reminder to run release.sh
- release.sh may not be necessary, as the goal of this PR is to remove the development branch entirely.

Here's what has to happen:
~~- [ ] Ensure the changelog has everything new that is being added~~
~~- [ ] Bump version (run updateVersion.sh)~~

Wait for CI
Merge
~~1. Run release.sh~~

tests are now run on GitHub Actions, for PRs and pushes Travis CI now runs only Danger and documentation deployment

I don't know why, but this is taking like 15 minutes and counting to install

Samasaur · 2020-10-31T17:12:41Z

	Fails
🚫	Task 1 incomplete: Ensure the changelog has everything new that is being added
🚫	Task 2 incomplete: Bump version (run `updateVersion.sh`)
🚫	The CHANGELOG was not updated! (put your changes in the UPCOMING section)
🚫	There is no CHANGELOG entry for this version!
🚫	PR title specifies version 0.25.0, while .jazzy.yaml specifies 0.24.1
🚫	Version was not updated in .jazzy.yaml!
🚫	.jazzy.yaml#L5 - Version was not updated in .jazzy.yaml!

	Messages
📖	The new version is v0.25.0
📖	Pull request to `master` for new version detected

module_version: 0.25.0

Generated by 🚫 Danger Swift against 4ab8a1e

The idea is that all PRs will be to master, but that only some PRs will be a 'new version'.

It probably won't work, but I should keep trying.

I tried to figure out how danger/swift and danger/js interact, and I think I more or less got it, but unless this works I think I will need to make a feature request

Samasaur1 · 2020-11-01T19:54:52Z

Here's the problem I've got: I want Danger to report both as a status check, and as a comment, with inline comments/fails/suggestion support. I also want Danger to run on PRs from forks, which mean I need to expose an API Token for either my account or @Samasaur, my bot account, which means that it could be extracted, which means I need to be careful about its allowed scopes.

The two potential scopes to use are (from this list):

public_repo
repo:status

public_repo allows commenting, but its problems are:

it only lets you report status checks / do inline comments on repos the account has write access to, but if you give the account write access to the repo, it can change the code (and because it is made public so that it can work with forks, this is unacceptable)

repo:status allows reporting status without code access, even when the account has write access to the repo, but:

it doesn't seem to be able to comment
it needs write access to the repo, so cannot be combined with a public_repo token.
doesn't seem to allow inline comments/suggestions/fails

I think ideally there'd be a comment scope so I could create a token with repo:status and comment scope, give the account write access to the repo, and use that. But since that doesn't exist, I'm not sure what to do.

Samasaur1 · 2022-06-01T05:43:13Z

It might be possible to do what I have listed above using two bot accounts, but at this point I don't care. And Travis CI has now stopped supporting open-source CI (I think?) so I have to deal with that too

Samasaur1 · 2022-06-01T05:45:12Z

Really I just have to choose between comments without status checks and status checks without comments. Either one will work, since I trust myself to see read comments before merging, and status checks will force me to wait for them. Actually, I'll probably go with status checks, just in case I miss the comment. I think Danger should let me get fairly granular and specific with the status checks, which is nice.

Samasaur1 · 2022-06-01T05:45:28Z

I was hoping to remove Danger completely, since it's kinda a pain, but c'est la vie

Samasaur1 · 2022-06-01T05:50:08Z

with GitHub Actions maybe I can run Danger for status checks as myself and leave comments as my bot user?

This might fail without an API token

github-actions · 2022-06-03T00:09:04Z

	Messages
📖	Pull request to `master` for new version detected
📖	The new version is v0.25.0
📖	.jazzy.yaml was updated
📖	PR title and .jazzy.yaml agree
📖	There is a CHANGELOG entry for this version
📖	The CHANGELOG entry heading is correct
📖	Upcoming link was updated to show changes between latest version and `master`
📖	Link line compares to the new version
📖	The CHANGELOG was updated
📖	PR has no tasks (are you sure?)

Generated by 🚫 Danger Swift against f1a42eb

Samasaur1 · 2022-06-03T21:18:34Z

I also need to fix Danger again, because the tasks are output in the wrong order

Samasaur1 · 2022-06-03T21:19:47Z

And I don't know what it's complaining about with the two link comments, because I'm fairly sure they're right — I'll double-check

Samasaur1 · 2022-06-03T21:22:38Z

I'm also still seeing

Response: {
[38](https://github.com/Samasaur1/DiceKit/runs/6732668468?check_suite_focus=true#step:4:39)
  "message": "Resource not accessible by integration",
[39](https://github.com/Samasaur1/DiceKit/runs/6732668468?check_suite_focus=true#step:4:40)
  "documentation_url": "https://docs.github.com/rest/reference/users#get-the-authenticated-user"
[40](https://github.com/Samasaur1/DiceKit/runs/6732668468?check_suite_focus=true#step:4:41)
}

in the Danger logs, which I believe is due to Danger running in the PR and therefore the token not having write access. For now, it's able to comment because the PR isn't coming from a fork, but I probably want to change this to use the pull_request_target event (and use the Dangerfile from my repo, so that the token can't be exploited that way).. See here: https://github.saobby.my.eu.orgmunity/t/github-actions-are-severely-limited-on-prs/18179/20

Samasaur1 · 2022-06-03T21:27:45Z

And I don't know what it's complaining about with the two link comments, because I'm fairly sure they're right — I'll double-check

OK, well, I was wrong. I had the compare backwards.

Samasaur1 · 2022-06-03T21:32:50Z

The other link complaint is because I have the CHANGELOG comparing against development instead of master. This is a more conceptual problem. Before this PR, everything was first merged into development and then only merged into master, from development, after that. The important idea about doing it this way was that every commit to master was a version.

The new idea is that there will be no development branch. Everything will be merged directly into master, and when enough stuff is there to warrant a new version, then we tag it (and now docs and releases will be done automatically after that).

So what Danger is saying (i.e., what past-me who set up Danger was saying) is that upcoming changes shouldn't be comparing development to master, they should be comparing master to the last version.

Samasaur1 · 2022-06-03T21:33:09Z

Also, the other link comment was resolved when Danger finished

Samasaur1 · 2022-06-03T21:34:12Z

I also need to update the required checks on PRs

Samasaur1 · 2022-06-04T14:27:38Z

OK so I have seen the Danger inline comments/fails. I don't know why they don't work consistently (possibly because there were too many submitted at once/), but I think it's good enough. I'll also create an issue about making Danger work for other people's contributions.

Samasaur1 and others added 6 commits October 17, 2020 18:14

Update Dangerfile with comments and to perform more tests

57566a2

Make PR template easier to follow

e0de1a5

Rework CI

be7169b

tests are now run on GitHub Actions, for PRs and pushes Travis CI now runs only Danger and documentation deployment

Add Package.resolved.danger

f9721e6

Fix GitHub Actions PR trigger

6edd65b

Don't test 5.3 on ubuntu-latest

b09d1f3

I don't know why, but this is taking like 15 minutes and counting to install

Samasaur1 and others added 8 commits October 31, 2020 13:30

Skip Swift 5.2 on macOS and fix Hound complaints

ad2a097

Update Dangerfile for new behavior

0d6580d

The idea is that all PRs will be to master, but that only some PRs will be a 'new version'.

Fix misspelling and read full Jazzy version

eb649bc

Include Swift 5.2 on macOS

7bc2f92

It probably won't work, but I should keep trying.

Use both Danger tokens

684ee95

Run Danger as two separate jobs

5a5d014

Build danger-swift before running

b9a231a

Explicitly use GitHub checks

4ab8a1e

I tried to figure out how danger/swift and danger/js interact, and I think I more or less got it, but unless this works I think I will need to make a feature request

Samasaur1 added 7 commits June 2, 2022 18:09

Use current versions of Swift and OSs

4c59b4d

Temporarily disable multiple Swift versions

74a5c79

Actually disable Swift versions

1e25663

Disable Ubuntu 22.04

905ff18

Try to use Danger

7c3e4b3

This might fail without an API token

Fix Danger workflow file

929519e

Add github token to Danger

af41743

Samasaur1 added 2 commits June 2, 2022 20:39

Use prebundled version of Swift to try and avoid inconsistency

bb95b8e

Use Swift 5.3 for Danger

44a9a53

Fix compare link

eeb3354

Samasaur1 added 14 commits June 3, 2022 18:35

Hopefully fix Danger task listing

631fb3f

Try to debug Dangerfile

414b3b7

Fix tests workflow

e0516c1

Add test summary to job summary

6e6ff11

Fix test workflow

393aec9

Only use fancy test statuses on Ubuntu

b39f69e

We can still have somewhat-nice statuses

622b629

Try to fix test workflow (again)

2c3d4f2

Fix test workflow

048de4c

Is this the problem?

0000ec5

Ah, it was a YAML error

6de5054

Force the use of emdashes in CHANGELOG

8e5ced8

Escape square brackets in regex

1e2f077

Forcibly correct CHANGELOG entry headings

7cacf27

Samasaur1 added 2 commits June 4, 2022 10:36

Clean up PR template

4354e5d

It's perfectly fine for a PR not to have any tasks

f1a42eb

Samasaur1 merged commit f8b229d into master Jun 4, 2022

Samasaur1 deleted the rework-ci-and-contributions branch June 4, 2022 15:29

This was referenced Jun 4, 2022

Make Danger work on PRs from forks #100

Open

Version 0.25.1: Fix deploy script #101

Merged

Samasaur1 mentioned this pull request Jun 30, 2022

Update CONTRIBUTING.md to describe new contributing workflow #106

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Version 0.25.0: Rework CI and Contributions #90

Version 0.25.0: Rework CI and Contributions #90

Samasaur1 commented Oct 31, 2020 •

edited

Loading

Samasaur commented Oct 31, 2020 •

edited

Loading

Samasaur1 commented Nov 1, 2020

Samasaur1 commented Jun 1, 2022

Samasaur1 commented Jun 1, 2022

Samasaur1 commented Jun 1, 2022

Samasaur1 commented Jun 1, 2022

github-actions bot commented Jun 3, 2022 •

edited

Loading

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022 •

edited

Loading

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 4, 2022

Version 0.25.0: Rework CI and Contributions #90

Version 0.25.0: Rework CI and Contributions #90

Conversation

Samasaur1 commented Oct 31, 2020 • edited Loading

Samasaur commented Oct 31, 2020 • edited Loading

Samasaur1 commented Nov 1, 2020

Samasaur1 commented Jun 1, 2022

Samasaur1 commented Jun 1, 2022

Samasaur1 commented Jun 1, 2022

Samasaur1 commented Jun 1, 2022

github-actions bot commented Jun 3, 2022 • edited Loading

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 3, 2022 • edited Loading

Samasaur1 commented Jun 3, 2022

Samasaur1 commented Jun 4, 2022

Samasaur1 commented Oct 31, 2020 •

edited

Loading

Samasaur commented Oct 31, 2020 •

edited

Loading

github-actions bot commented Jun 3, 2022 •

edited

Loading

Samasaur1 commented Jun 3, 2022 •

edited

Loading