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

feat: adapt for probot v11. Use @actions/core for logging #19

Merged
merged 5 commits into from
Feb 10, 2021
Merged

Conversation

gr2m
Copy link
Contributor

@gr2m gr2m commented Feb 9, 2021

closes #16

BREAKING CHANGE: package name has been renamed to "@probot/adapter-github-actions"

BREAKING CHANGE: the package now has the same export as "probot".

Before

const runProbot = require('probot-actions-adapter');
const app = require('./app');
runProbot(app);

After

const { run } = require("@probot/adapter-github-actions");
const app = require("./app");
run(app);

View rendered LICENSE.md
View rendered README.md

BREAKING CHANGE: package name has been renamed to "@probot/adapter-github-actions"

BREAKING CHANGE: the package now has the same export as `"probot"`.

Before

```js
const runProbot = require('probot-actions-adapter');
const app = require('./index');
runProbot(app);
```

After

```js
const { run } = require("@probot/adapter-github-actions");
const app = require("./app");
run(app);
```
@gr2m gr2m mentioned this pull request Feb 9, 2021
@gr2m gr2m requested a review from swinton February 9, 2021 19:14
@gr2m
Copy link
Contributor Author

gr2m commented Feb 9, 2021

@swinton this is basically a total rewrite, I'd appreciate if you could have a look. If we decide to merge, I'd deprecate the current probot-actions-adapter package on npm

@gr2m gr2m changed the title feat: adapt for probot v11 feat: adapt for probot v11. Use @actions/core for logging Feb 9, 2021
gr2m added a commit to probot/example-github-action that referenced this pull request Feb 9, 2021
gr2m added a commit to probot/example-github-action that referenced this pull request Feb 9, 2021
gr2m added a commit to probot/example-github-action that referenced this pull request Feb 9, 2021
gr2m added a commit to probot/example-github-action that referenced this pull request Feb 9, 2021
Copy link
Contributor

@swinton swinton left a comment

Choose a reason for hiding this comment

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

Thanks for all the work here, @gr2m. I love the new name as well! I had one README suggestion...

```

### Example `action.yml`
Then use `index.js` as your entrypoint in the `action.yml` file
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a bit more nuance here to unpack.

Users can either:

  1. Commit their node_modules
  2. Compile their JS down to a single executable script (e.g. via @vercel/ncc -- this is my preference)

Perhaps we can lean on the docs to unpack this nuance: https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#commit-tag-and-push-your-action-to-github

Suggested change
Then use `index.js` as your entrypoint in the `action.yml` file
Follow the official GitHub documentation for next steps including:
1. [Creating an action metadata file](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#creating-an-action-metadata-file)
1. [Commit, tag, and push your action to GitHub](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#commit-tag-and-push-your-action-to-github)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay like this? 6760bd2

Copy link
Contributor

@jetersen jetersen left a comment

Choose a reason for hiding this comment

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

LGTM 👏

@gr2m gr2m merged commit 4aa298d into master Feb 10, 2021
@gr2m gr2m deleted the probot-v11 branch February 10, 2021 18:48
@github-actions
Copy link

🎉 This PR is included in version 3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants