feat: ignore existing files previous to commits in push event (#19)

* feat: ignore existing files

* ci: setup dependabot

* docs: update docs

* feat: add build

Author: protiumx

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"

README.md

@@ -2,7 +2,10 @@
 
 [![CI](https://github.com/protiumx/blogpub/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/protiumx/blogpub/actions/workflows/ci.yml)
 
-Github action to publish your blog articles to [Medium](https://medium.com/) or [Dev.to](http://dev.to/)
+Github action to publish your blog articles to [Medium](https://medium.com/) or [Dev.to](http://dev.to/).
+It gets the files from a `push` event and process the first `md` file that find.
+**The file is ignored if it already existed before the push event.** 
+This avoid publishing again when making fixes on an existing article.
 
 ## Pre-requisites
 

build/blogpub.js

@@ -14,7 +14,7 @@ type Github = ReturnType<typeof getOctokit>;
 
 async function loadArticleFile(
   github: Github, folderName: string,
-): Promise<{ fileName: string, content: string}> {
+): Promise<{ fileName: string, content: string }> {
   const { owner, repo } = context.repo;
   // NOTE: Pagination returns 30 files by default
   const commit = (
@@ -37,6 +37,19 @@ async function loadArticleFile(
   return { fileName: newArticle.filename!, content };
 }
 
+// Check if file already existed in a commit
+async function checkFileExists(github: Github, filePath: string, ref: string): Promise<boolean> {
+  const { owner, repo } = context.repo;
+  const res = await github.request('GET /repos/{owner}/{repo}/contents/{path}/{?ref}', {
+    owner,
+    repo,
+    ref,
+    path: filePath,
+  });
+  return res.status === 200;
+}
+
+
 export async function run() {
   try {
     const ghToken = core.getInput('gh_token', { required: true });
@@ -45,10 +58,20 @@ export async function run() {
     const mediumUserId = core.getInput('medium_user_id', { required: true });
     const mediumBaseUrl = core.getInput('medium_base_url', { required: false });
     const devtoApiKey = core.getInput('devto_api_key', { required: true });
+    // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-unsafe-assignment
+    const eventPayload = require(process.env.GITHUB_EVENT_PATH as string);
 
     const github = getOctokit(ghToken);
 
     const articleFile = await loadArticleFile(github, articlesFolder);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument
+    const articleAlreadyExists = await checkFileExists(github, articleFile.fileName, eventPayload.before);
+    /* istanbul ignore next */
+    if (articleAlreadyExists) {
+      /* istanbul ignore next */
+      core.debug(`Article ${articleFile.fileName} already published. Skipping.`);      
+      return;
+    }
     const rawGithubUrl = context.serverUrl
       .replace('//github.com', '//raw.githubusercontent.com');
     const { repo, owner } = context.repo;

src/main.ts

@@ -36,20 +36,26 @@ jest.mock('@actions/github', () => ({
 }));
 jest.mock('@actions/core');
 
+process.env.GITHUB_EVENT_PATH = 'event.json';
+jest.mock('event.json', () => ({
+  // __esModule: true,
+  default: { before: 'sha' },
+}), { virtual: true });
+
 describe('blogpub', () => {
   beforeEach(jest.clearAllMocks);
 
   (getOctokit as jest.Mock).mockReturnValue(octokitMock);
 
   const fileData = {
-      data: {
-        files: [
-          {
-            filename: 'blogs/blog-01.md',
-          },
-        ],
-      },
-    };
+    data: {
+      files: [
+        {
+          filename: 'blogs/blog-01.md',
+        },
+      ],
+    },
+  };
 
   it('should set failed when fails to get PR info', async () => {
     const err = new Error('github');
@@ -99,8 +105,26 @@ describe('blogpub', () => {
     expect(promises.readFile).toHaveBeenCalledWith('./blogs/blog-01.md', 'utf8');
     expect(core.setFailed).toHaveBeenCalledWith(err);
   });
+  
+  it('should skip if file already exists in repository', async () => {
+    (core.getInput as jest.Mock).mockImplementation((key: string) => {
+      return key === 'articles_folder' ? 'blogs' : '';
+    });
+    octokitMock.request.mockResolvedValue({
+      data: {
+        files: [
+          {
+            filename: 'readme.txt',
+          },
+        ],
+      },
+    });
+    octokitMock.request.mockResolvedValueOnce({ status: 200 });
+    await run();
+    expect(parseArticle).not.toHaveBeenCalled();
+  });
 
-  it('should set failed if fails to parse article', async () => {
+  it('should set failed if fails to parse file into article', async () => {
     (core.getInput as jest.Mock).mockImplementation((key: string) => {
       return key === 'articles_folder' ? 'blogs' : '';
     });
@@ -111,7 +135,8 @@ describe('blogpub', () => {
     (parseArticle as jest.Mock).mockImplementation(() => {
       throw err;
     });
-    octokitMock.request.mockResolvedValue(fileData);
+    octokitMock.request.mockResolvedValueOnce(fileData);
+    octokitMock.request.mockResolvedValueOnce({ status: 404 });
 
     await run();
 
@@ -143,7 +168,8 @@ describe('blogpub', () => {
       content: 'parsed',
     });
     (medium.createArticle as jest.Mock).mockRejectedValue(err);
-    octokitMock.request.mockResolvedValue(fileData);
+    octokitMock.request.mockResolvedValueOnce(fileData);
+    octokitMock.request.mockResolvedValueOnce({ status: 404 });
 
     await run();
 
@@ -168,7 +194,8 @@ describe('blogpub', () => {
     });
     (devto.createArticle as jest.Mock).mockRejectedValue(new Error(''));
     (medium.createArticle as jest.Mock).mockResolvedValue({ url: 'medium.com/new' });
-    octokitMock.request.mockResolvedValue(fileData);
+    octokitMock.request.mockResolvedValueOnce(fileData);
+    octokitMock.request.mockResolvedValueOnce({ status: 404 });
 
     await run();
 
@@ -203,7 +230,8 @@ describe('blogpub', () => {
     });
     (medium.createArticle as jest.Mock).mockResolvedValue({ url: 'medium.com/new' });
     (devto.createArticle as jest.Mock).mockRejectedValue(err);
-    octokitMock.request.mockResolvedValue(fileData);
+    octokitMock.request.mockResolvedValueOnce(fileData);
+    octokitMock.request.mockResolvedValueOnce({ status: 404 });
 
     await run();
 
@@ -236,7 +264,8 @@ describe('blogpub', () => {
     });
     (medium.createArticle as jest.Mock).mockResolvedValue({ url: 'medium.com/new' });
     (devto.createArticle as jest.Mock).mockResolvedValue({ url: 'dev.to/new' });
-    octokitMock.request.mockResolvedValue(fileData);
+    octokitMock.request.mockResolvedValueOnce(fileData);
+    octokitMock.request.mockResolvedValueOnce({ status: 404 });
 
     await run();