Skip to content

Merge develop into master #15

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Dec 17, 2024
Merged

Merge develop into master #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
15c076f
improve logic get viewer
thanhhaudev Sep 23, 2024
a89ab0e
improve logic get viewer (#14)
thanhhaudev Sep 23, 2024
bfe38d8
chore!: remame COMMIT_TIME_OF_DAY to COMMIT_TIMES_OF_DAY
thanhhaudev Dec 13, 2024
d6a5eca
chore: fix typo
thanhhaudev Dec 13, 2024
86f5a51
chore: update typo
thanhhaudev Dec 16, 2024
5b5f220
feature: add SIMPLIFY_COMMIT_TITLE
thanhhaudev Dec 17, 2024
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
53 changes: 27 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,30 +34,31 @@ This GitHub Action collects your GitHub data and coding activity from WakaTime.
## Usage

### Environment Variables
| Name | Description | Required | Default |
|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|---------------------------|
| `GITHUB_TOKEN` | The GitHub token to authenticate API requests. | Yes | - |
| `SHOW_METRICS` | The metrics to show in the `README.md` file. | Yes | - |
| `WAKATIME_API_KEY` | The WakaTime API key to fetch coding activity statistics. | No | - |
| `WAKATIME_RANGE` | The range for WakaTime statistics (e.g., `last_7_days`, `last_30_days`, `last_6_months`, `last_year`, `all_time`). | No | last_7_days |
| `WAKATIME_DATA` | The data to show from WakaTime statistics. | If `WAKATIME_API_KEY` is provided | - |
| `TIME_ZONE` | The timezone to use for statistics. | No | UTC |
| `TIME_LAYOUT` | The layout of the time to show in the last update time. | No | 2006-01-02 15:04:05 -0700 |
| `SHOW_LAST_UPDATE` | Whether to show the last update time in the `README.md` file. | No | - |
| `ONLY_MAIN_BRANCH` | Whether to fetch data only from the main branch. If you don’t set this, it will search for commits in all branches of the repository to count the number of commits, which might take more time. | No | - |
| `COMMIT_MESSAGE` | The commit message to use when updating the `README.md`. | No | 📝 Update README.md |
| `COMMIT_USER_NAME` | The name to use for the commit. | No | GitHub Action |
| `COMMIT_USER_EMAIL` | The email to use for the commit. | No | action@github.com |
| `SECTION_NAME` | The section name in the `README.md` to update. | No | readme-stats |
| `HIDE_REPO_INFO` | Whether to hide the repository information in action logs. | No | - |
| `PROGRESS_BAR_VERSION` | The version of the progress bar to use. | No | 1 |
| `EXCLUDE_FORK_REPOS` | Whether to exclude fork repositories from the metrics. | No | - |
| `LANGUAGES_AND_TOOLS` | The languages and tools that you used in your repositories. | No | - |
| Name | Description | Required | Default |
|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|---------------------------|
| `GITHUB_TOKEN` | The GitHub token to authenticate API requests. | Yes | - |
| `SHOW_METRICS` | The metrics to show in the `README.md` file. | Yes | - |
| `WAKATIME_API_KEY` | The WakaTime API key to fetch coding activity statistics. | No | - |
| `WAKATIME_RANGE` | The range for WakaTime statistics (e.g., `last_7_days`, `last_30_days`, `last_6_months`, `last_year`, `all_time`). | No | last_7_days |
| `WAKATIME_DATA` | The data to show from WakaTime statistics. | If `WAKATIME_API_KEY` is provided | - |
| `TIME_ZONE` | The timezone to use for statistics. | No | UTC |
| `TIME_LAYOUT` | The layout of the time to show in the last update time. | No | 2006-01-02 15:04:05 -0700 |
| `SHOW_LAST_UPDATE` | Whether to show the last update time in the `README.md` file. | No | - |
| `ONLY_MAIN_BRANCH` | Whether to fetch data only from the main branch. If you don’t set this, it will search for commits in all branches of the repository to count the number of commits, which might take more time. | No | - |
| `COMMIT_MESSAGE` | The commit message to use when updating the `README.md`. | No | 📝 Update README.md |
| `COMMIT_USER_NAME` | The name to use for the commit. | No | GitHub Action |
| `COMMIT_USER_EMAIL` | The email to use for the commit. | No | action@github.com |
| `SECTION_NAME` | The section name in the `README.md` to update. | No | readme-stats |
| `HIDE_REPO_INFO` | Whether to hide the repository information in action logs. | No | - |
| `PROGRESS_BAR_VERSION` | The version of the progress bar to use. | No | 1 |
| `EXCLUDE_FORK_REPOS` | Whether to exclude fork repositories from the metrics. | No | - |
| `LANGUAGES_AND_TOOLS` | The languages and tools that you used in your repositories. | No | - |
| `SIMPLIFY_COMMIT_TIMES_TITLE` | If you want to display a simplified title when using `COMMIT_TIMES_OF_DAY`, enable this option to show either "I'm An Early 🐤" or "I'm A Night 🦉" based on the commit time. | No | - |

### Metrics
The `SHOW_METRICS` environment variable is used to specify the metrics to show in the `README.md` file. You can choose from the following metrics:

**COMMIT_TIME_OF_DAY**: The time of day you make commits.
**COMMIT_TIMES_OF_DAY**: The distribution of your commits across different times of the day, such as morning, daytime, evening, and night.

**🕒 I'm An Afternoon Warrior 🥷🏻**
```
Expand Down Expand Up @@ -143,11 +144,11 @@ Use the `WAKATIME_DATA` environment variable to specify the data to show.
```

You can use the `WAKATIME_RANGE` environment variable to set the time range for WakaTime statistics. Each value will show a specific label as follows:
+ `last_7_days`: 📊 This Week I Spent My Time On
+ `last_30_days`: 📊 This Month I Spent My Time On
+ `last_6_months`: 📊 In the Last 6 Months I Spent My Time On
+ `last_year`: 📊 This Year I Spent My Time On
+ `all_time`: 📊 All The Time I Spent On
+ `last_7_days`: What I Focused On in the Last 7 Days
+ `last_30_days`: How I Spent My Time Over the Last 30 Days
+ `last_6_months`: Where My Time Went in the Last 6 Months
+ `last_year`: My Time Highlights from Last Year
+ `all_time`: How I’ve Used My Time Across All Time

**Note**: If you don't provide the `WAKATIME_API_KEY`, the `WAKATIME_SPENT_TIME` metric will not be shown.

Expand Down Expand Up @@ -187,7 +188,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} # GitHub token, required
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
WAKATIME_DATA: "EDITORS,LANGUAGES,PROJECTS,OPERATING_SYSTEMS" # show data, separated by comma
SHOW_METRICS: "COMMIT_TIME_OF_DAY,LANGUAGE_PER_REPO,COMMIT_DAYS_OF_WEEK,WAKATIME_SPENT_TIME" # show metrics, separated by comma
SHOW_METRICS: "COMMIT_TIMES_OF_DAY,LANGUAGE_PER_REPO,COMMIT_DAYS_OF_WEEK,WAKATIME_SPENT_TIME" # show metrics, separated by comma
SHOW_LAST_UPDATE: "true" # show last update time
ONLY_MAIN_BRANCH: "true" # only fetch data from the main branch
```
Expand Down
3 changes: 3 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ inputs:
EXCLUDE_FORK_REPOS:
description: 'Exclude fork repositories'
required: false
SIMPLIFY_COMMIT_TIMES_TITLE:
description: 'Simply title for COMMIT_TIMES_OF_DAY'
required: false
runs:
using: docker
image: Dockerfile
Expand Down
6 changes: 5 additions & 1 deletion pkg/container/container.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func (d *DataContainer) metrics(com *CommitStats, lang *LanguageStats) map[strin
"LANGUAGE_PER_REPO": writer.MakeLanguagePerRepoList(d.Data.Repositories),
"LANGUAGES_AND_TOOLS": writer.MakeLanguageAndToolList(lang.Languages, lang.TotalSize),
"COMMIT_DAYS_OF_WEEK": writer.MakeCommitDaysOfWeekList(com.DailyCommits, com.TotalCommits),
"COMMIT_TIME_OF_DAY": writer.MakeCommitTimeOfDayList(d.Data.Commits),
"COMMIT_TIMES_OF_DAY": writer.MakeCommitTimesOfDayList(d.Data.Commits),
"WAKATIME_SPENT_TIME": writer.MakeWakaActivityList(
d.Data.WakaTime,
strings.Split(os.Getenv("WAKATIME_DATA"), ","),
Expand Down Expand Up @@ -88,6 +88,10 @@ func (d *DataContainer) InitViewer(ctx context.Context) error {
return err
}

if v == nil {
return fmt.Errorf("❌ could not fetch viewer information, please check your GitHub token")
}

d.Data.Viewer = v

return nil
Expand Down
21 changes: 13 additions & 8 deletions pkg/writer/format.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,29 @@ var longWeekTimeNames = []string{
"Night",
}

var weekTimeEmoji = []string{
var timesOfDayEmoji = []string{
"🌅",
"🌞",
"🌆",
"🌙",
}

var weekTimeStatuses = []string{
"An Early Bird 🐣",
var longTimesOfDayStatuses = []string{
"An Early Bird 🐤",
"An Afternoon Warrior 🥷🏻",
"A Twilight Taskmaster 🌆",
"A Night Owl 🦉",
}

var timesOfDayStatuses = []string{
"An Early 🐤",
"A Night 🦉",
}

var wakaRangeNames = map[string]string{
"last_7_days": "This Week I Spent My Time On",
"last_30_days": "This Month I Spent My Time On",
"last_6_months": "In the Last 6 Months I Spent My Time On",
"last_year": "This Year I Spent My Time On",
"all_time": "All The Time I Spent On",
"last_7_days": "What I Focused On in the Last 7 Days",
"last_30_days": "How I Spent My Time Over the Last 30 Days",
"last_6_months": "Where My Time Went in the Last 6 Months",
"last_year": "My Time Highlights from Last Year",
"all_time": "How I’ve Used My Time Across All Time",
}
19 changes: 14 additions & 5 deletions pkg/writer/writer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ func MakeLastUpdatedOn(t string) string {
return fmt.Sprintf("\n\n*⏳ Last updated on %s*", t)
}

// MakeCommitTimeOfDayList returns a list of commits made during different times of the day
func MakeCommitTimeOfDayList(commits []github.Commit) string {
// MakeCommitTimesOfDayList returns a list of commits made during different times of the day
func MakeCommitTimesOfDayList(commits []github.Commit) string {
if len(commits) == 0 {
return ""
}
Expand Down Expand Up @@ -168,14 +168,14 @@ func MakeCommitTimeOfDayList(commits []github.Commit) string {

for i, n := range longWeekTimeNames {
weekTime := WeekTime(i)
weekCommit := counts[WeekTime(i)]
weekCommit := counts[weekTime]
if weekCommit > topVal {
topVal = weekCommit
topWeek = weekTime
}

data = append(data, Data{
Name: fmt.Sprintf("%s %s", weekTimeEmoji[weekTime], n),
Name: fmt.Sprintf("%s %s", timesOfDayEmoji[weekTime], n),
Description: fmt.Sprintf("%s %s", addCommas(weekCommit), func() string {
if weekCommit > 1 {
return "commits"
Expand All @@ -187,7 +187,16 @@ func MakeCommitTimeOfDayList(commits []github.Commit) string {
})
}

return fmt.Sprintf("**🕒 I'm %s**\n\n", weekTimeStatuses[topWeek]) + "```text" + makeList(data...) + "```\n\n"
status := longTimesOfDayStatuses[topWeek]
if os.Getenv("SIMPLIFY_COMMIT_TIMES_TITLE") == "true" {
if (data[0].Percent + data[1].Percent) > (data[2].Percent + data[3].Percent) {
status = timesOfDayStatuses[0]
} else {
status = timesOfDayStatuses[1]
}
}

return fmt.Sprintf("**🕒 I'm %s**\n\n", status) + "```text" + makeList(data...) + "```\n\n"
}

// MakeCommitDaysOfWeekList returns a list of commits made on each day of the week
Expand Down