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.

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

v0.5.0 #102

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

v0.5.0 #102

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5ec258
feat: add direct urls for comments
tuunit Jun 3, 2023
e74c153
bugfix: release url generation
tuunit Jun 6, 2023
9d9c8bf
feat: add pagination support and fix a bug when increasing the max_lines
tuunit Jun 8, 2023
f5c20aa
change error message handling and remove uncessary debug log entry
tuunit Jul 3, 2023
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
179 changes: 90 additions & 89 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1804,8 +1804,6 @@ const TARGET_FILE = core.getInput("TARGET_FILE");

const capitalize = (str) => str.slice(0, 1).toUpperCase() + str.slice(1);

const urlPrefix = "https://github.com";

/**
* Returns a URL in markdown format for PR's and issues
* @param {Object | String} item - holds information concerning the issue/PR
Expand All @@ -1814,12 +1812,28 @@ const urlPrefix = "https://github.com";
*/

const toUrlFormat = (item) => {
if (typeof item === "object") {
return Object.hasOwnProperty.call(item.payload, "issue")
? `[#${item.payload.issue.number}](${urlPrefix}/${item.repo.name}/issues/${item.payload.issue.number})`
: `[#${item.payload.pull_request.number}](${urlPrefix}/${item.repo.name}/pull/${item.payload.pull_request.number})`;
if (typeof item !== "object") {
return `[${item}](https://github.com/${item})`;
}

if (Object.hasOwnProperty.call(item.payload, "comment")) {
return `[#${item.payload.issue.number}](${item.payload.comment.html_url})`;
}

if (Object.hasOwnProperty.call(item.payload, "issue")) {
return `[#${item.payload.issue.number}](${item.payload.issue.html_url})`;
}

if (Object.hasOwnProperty.call(item.payload, "pull_request")) {
return `[#${item.payload.pull_request.number}](${item.payload.pull_request.html_url})`;
}

if (Object.hasOwnProperty.call(item.payload, "release")) {
const release = item.payload.release.name
? item.payload.release.name
: item.payload.release.tag_name;
return `[${release}](${item.payload.release.html_url})`;
}
return `[${item}](${urlPrefix}/${item})`;
};

/**
Expand Down Expand Up @@ -1883,40 +1897,71 @@ const serializers = {
},
ReleaseEvent: (item) => {
return `🚀 ${capitalize(item.payload.action)} release ${toUrlFormat(
item.payload.release.name
? item.payload.release.name
: item.payload.release.tag_name
item
)} in ${toUrlFormat(item.repo.name)}`;
},
};

Toolkit.run(
async (tools) => {
// Get the user's public events
tools.log.debug(`Getting activity for ${GH_USERNAME}`);
const events = await tools.github.activity.listPublicEventsForUser({
username: GH_USERNAME,
per_page: 100,
});

let page = 1;
let events = [];

while (events.length < MAX_LINES) {
let data = [];

try {
// Get the user's public events
const resp = await tools.github.activity.listPublicEventsForUser({
username: GH_USERNAME,
per_page: 100,
page: page,
});

data = resp.data;
} catch (err) {
// Catch any HTTP errors. Especially because the API pagination is
// limited and throws an error when reaching the end
tools.log.info(err);
break;
}

events = [
...events,
...data
// Filter out any boring activity
.filter((event) => serializers.hasOwnProperty(event.type))
// We only have five lines to work with
.slice(0, MAX_LINES)
// Call the serializer to construct a string
.map((item) => serializers[item.type](item)),
];

// Remove duplicates
events = [...new Set(events)];

// Break out of the loop if we have enough events
if (events.length >= MAX_LINES) {
events = events.slice(0, MAX_LINES);
break;
}

page++;
}

tools.log.debug(
`Activity for ${GH_USERNAME}, ${events.data.length} events found.`
`Activity for ${GH_USERNAME}: ${events.length} relevant events found.`
);

const content = events.data
// Filter out any boring activity
.filter((event) => serializers.hasOwnProperty(event.type))
// We only have five lines to work with
.slice(0, MAX_LINES)
// Call the serializer to construct a string
.map((item) => serializers[item.type](item));

const readmeContent = fs
.readFileSync(`./${TARGET_FILE}`, "utf-8")
.split("\n");

// Find the index corresponding to <!--START_SECTION:activity--> comment
let startIdx = readmeContent.findIndex(
(content) => content.trim() === "<!--START_SECTION:activity-->"
(line) => line.trim() === "<!--START_SECTION:activity-->"
);

// Early return in case the <!--START_SECTION:activity--> comment was not found
Expand All @@ -1928,83 +1973,39 @@ Toolkit.run(

// Find the index corresponding to <!--END_SECTION:activity--> comment
const endIdx = readmeContent.findIndex(
(content) => content.trim() === "<!--END_SECTION:activity-->"
(line) => line.trim() === "<!--END_SECTION:activity-->"
);

if (!content.length) {
tools.exit.success(
if (!events.length) {
return tools.exit.success(
"No PullRequest/Issue/IssueComment/Release events found. Leaving README unchanged with previous activity"
);
}

if (content.length < 5) {
tools.log.info("Found less than 5 activities");
// Remove all lines between <!--START_SECTION:activity--> and <!--END_SECTION:activity--> comment
if (endIdx !== -1) {
readmeContent.splice(startIdx + 1, endIdx - startIdx);
}

if (startIdx !== -1 && endIdx === -1) {
// Add one since the content needs to be inserted just after the initial comment
startIdx++;
content.forEach((line, idx) =>
readmeContent.splice(startIdx + idx, 0, `${idx + 1}. ${line}`)
);

// Append <!--END_SECTION:activity--> comment
readmeContent.splice(
startIdx + content.length,
0,
"<!--END_SECTION:activity-->"
if (events.length < MAX_LINES) {
tools.log.info(
`Found ${events.length} activities. Which is less than ${MAX_LINES} specified by MAX_LINES.`
);

// Update README
fs.writeFileSync(`./${TARGET_FILE}`, readmeContent.join("\n"));

// Commit to the remote repository
try {
await commitFile();
} catch (err) {
tools.log.debug("Something went wrong");
return tools.exit.failure(err);
}
tools.exit.success("Wrote to README");
}

const oldContent = readmeContent.slice(startIdx + 1, endIdx).join("\n");
const newContent = content
.map((line, idx) => `${idx + 1}. ${line}`)
.join("\n");

if (oldContent.trim() === newContent.trim())
tools.exit.success("No changes detected");

startIdx++;

// Recent GitHub Activity content between the comments
const readmeActivitySection = readmeContent.slice(startIdx, endIdx);
if (!readmeActivitySection.length) {
content.some((line, idx) => {
// User doesn't have 5 public events
if (!line) {
return true;
}
readmeContent.splice(startIdx + idx, 0, `${idx + 1}. ${line}`);
});
tools.log.success(`Wrote to ${TARGET_FILE}`);
} else {
// It is likely that a newline is inserted after the <!--START_SECTION:activity--> comment (code formatter)
let count = 0;
// Append new content
events.forEach((line, idx) =>
readmeContent.splice(startIdx + idx, 0, `${idx + 1}. ${line}`)
);

readmeActivitySection.some((line, idx) => {
// User doesn't have 5 public events
if (!content[count]) {
return true;
}
if (line !== "") {
readmeContent[startIdx + idx] = `${count + 1}. ${content[count]}`;
count++;
}
});
tools.log.success(`Updated ${TARGET_FILE} with the recent activity`);
}
// Append <!--END_SECTION:activity--> comment
readmeContent.splice(
startIdx + events.length,
0,
"<!--END_SECTION:activity-->"
);

// Update README
fs.writeFileSync(`./${TARGET_FILE}`, readmeContent.join("\n"));
Expand All @@ -2016,7 +2017,7 @@ Toolkit.run(
tools.log.debug("Something went wrong");
return tools.exit.failure(err);
}
tools.exit.success("Pushed to remote repository");
tools.exit.success("Wrote to README");
},
{
event: ["schedule", "workflow_dispatch"],
Expand Down
Loading