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

TypeScript rewrite, new options, improved workflows & whatnot #30

Open
wants to merge 32 commits into
base: typescript-rewrite
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
f947e7d
feat: add NO_DEPENDABOT option
EndBug Sep 14, 2020
aedc573
build: update dist
EndBug Sep 14, 2020
0dd6db5
chore: npm audit fix
EndBug Sep 14, 2020
db3369b
chore: run prettier
EndBug Sep 14, 2020
6625b8a
fix: fix initialization error
EndBug Sep 14, 2020
5f7a63a
Upload new action code
EndBug Sep 14, 2020
f61d037
ci: fix typo
EndBug Sep 14, 2020
b59ba64
ci: don't run tests on macOS
EndBug Sep 14, 2020
c740c63
ci: install dependecies
EndBug Sep 14, 2020
74eca0f
chore: lint source code
EndBug Sep 14, 2020
a73e419
build: update dist
EndBug Sep 14, 2020
cc8ea04
fix: minor fix
EndBug Sep 14, 2020
983567e
build: update dist
EndBug Sep 14, 2020
65fe788
fix: fix commit behaviour
EndBug Sep 14, 2020
f5a1b73
build: update dist
EndBug Sep 14, 2020
35baa4e
fix: try to filter out duplicates
EndBug Sep 14, 2020
ad6b90e
chore: lint source code
EndBug Sep 14, 2020
2f8b17a
build: update dist
EndBug Sep 14, 2020
b8af06f
ci: remove test workflow
EndBug Sep 14, 2020
86ea2e5
build: update dist
EndBug Sep 14, 2020
4ee59a6
chore: use git hooks instead of GH actions
EndBug Sep 19, 2020
72abe63
Merge branch 'master' of git://github.com/jamesgeorge007/github-activ…
EndBug Sep 26, 2020
9c6632d
Merge branch 'jamesgeorge007-master' into rewrite
EndBug Sep 26, 2020
b2ed64b
ci: add test workflow
EndBug Sep 26, 2020
3eec2c7
fix: change param to MAX_LINE (instead of LINE)
EndBug Nov 21, 2020
cc4a7e9
chore: rename workflow
EndBug Nov 21, 2020
f387559
fix: update email address
EndBug Nov 21, 2020
2ad1698
chore: fix conflicts
EndBug Nov 21, 2020
89301e2
chore: fix conflicts
EndBug Nov 21, 2020
fd9cb99
chore: fix conflicts
EndBug Nov 21, 2020
21796ff
chore: fix merge conflicts?
EndBug Nov 21, 2020
3052d7d
Merge branch 'rewrite' of https://github.com/EndBug/github-activity-r…
EndBug Nov 21, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
semi: false
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,9 @@ Please note that only those public events that belong to the following list show

You can find an example [here](https://github.com/jamesgeorge007/jamesgeorge007/blob/master/.github/workflows/update-readme.yml).

### Override defaults

Use the following `input params` to customize it for your use case:-

| Input Param | Default Value | Description |
|--------|--------|--------|
| `COMMIT_MSG` | :zap: Update README with the recent activity | Commit message used while committing to the repo |
| `MAX_LINES` | 5 | The maximum number of lines populated in your readme file |
### Custom commit message

Specify a custom commit message with the `COMMIT_MSG` input param.

```yml
name: Update README
Expand All @@ -74,7 +68,6 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
COMMIT_MSG: 'Specify a custom commit message'
MAX_LINES: 10
```

_Inspired by [JasonEtco/activity-box](https://github.com/JasonEtco/activity-box)_
20 changes: 14 additions & 6 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,25 @@ description: Updates README with the recent GitHub activity of a user
author: jamesgeorge007

inputs:
COMMIT_MSG:
description: 'Commit message used while committing to the repo'
default: ':zap: Update README with the recent activity'
required: false
GH_USERNAME:
description: 'Your GitHub username'
default: ${{ github.repository_owner }}
required: false
COMMIT_MSG:
description: "Commit message used while committing to the repo"
default: ":zap: Update README with the recent activity"
required: false
MAX_LINES:
description: "The maximum number of lines populated in your readme file"
default: 5
description: The number of lines to generate
default: '5'
required: false
NO_COMMIT:
Copy link
Owner

Choose a reason for hiding this comment

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

Can you explain the motivation behind introducing this input param?

Copy link
Author

Choose a reason for hiding this comment

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

Which one? NO_COMMIT or LINES?

  • NO_COMMIT: if someone wants to do some other edit to the README they can do it and then push all the changes in a single commit.
  • LINES: they can select the number of lines from the workflow

Copy link
Owner

Choose a reason for hiding this comment

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

We're checking to see if there is any difference between the content enclosed within the respective comments and the latest data being pulled. Any change made to other sections of the README doesn't affect this.

Copy link
Author

Choose a reason for hiding this comment

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

@jamesgeorge007 That's not the issue: I may want to do some other changes to the README and then commit everything together, instead of having multiple commits.

description: Whether not to commit the changed README
default: 'false'
required: false
NO_DEPENDABOT:
description: Whether to filter out PRs opened by Dependabot
default: 'false'
required: false

branding:
Expand Down
Loading