chore: rebrand to new repo name (DevtoGitHub)

Anmol-Baranwal · Feb 27, 2024 · 4451627 · 4451627
1 parent dcb3f43
commit 4451627
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 61 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -36,11 +36,11 @@ body:
     id: no-duplicate-issues
     attributes:
       label: "Checklist"
-      description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/DevSync/blob/main/CODE_OF_CONDUCT.md)"
+      description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/DevtoGitHub/blob/main/CODE_OF_CONDUCT.md)"
       options:
-        - label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/DevSync/issues?q=is%3Aissue+)"
+        - label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/DevtoGitHub/issues?q=is%3Aissue+)"
           required: true
-        - label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/DevSync/blob/main/Contributing.md)"
+        - label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/DevtoGitHub/blob/main/Contributing.md)"
           required: true
         - label: "I am willing to work on this issue (optional)"
           required: false
diff --git a/.github/ISSUE_TEMPLATE/discussion.yml b/.github/ISSUE_TEMPLATE/discussion.yml
@@ -14,5 +14,5 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/DevSync/issues?q=is%3Aissue+)"
+        - label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/DevtoGitHub/issues?q=is%3Aissue+)"
           required: true
diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml
@@ -22,11 +22,11 @@ body:
     id: terms_checklist_docs
     attributes:
       label: "Checklist"
-      description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/DevSync/blob/main/CODE_OF_CONDUCT.md)"
+      description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/DevtoGitHub/blob/main/CODE_OF_CONDUCT.md)"
       options:
-        - label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/DevSync/issues?q=is%3Aissue+)"
+        - label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/DevtoGitHub/issues?q=is%3Aissue+)"
           required: true
-        - label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/DevSync/blob/main/Contributing.md)"
+        - label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/DevtoGitHub/blob/main/Contributing.md)"
           required: true
         - label: "I am willing to work on this issue (optional)"
           required: false
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -21,11 +21,11 @@ body:
     id: no-duplicate-issues
     attributes:
       label: "Checklist"
-      description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/DevSync/blob/main/CODE_OF_CONDUCT.md)"
+      description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/DevtoGitHub/blob/main/CODE_OF_CONDUCT.md)"
       options:
-        - label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/DevSync/issues?q=is%3Aissue+)"
+        - label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/DevtoGitHub/issues?q=is%3Aissue+)"
           required: true
-        - label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/DevSync/blob/main/Contributing.md)"
+        - label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/DevtoGitHub/blob/main/Contributing.md)"
           required: true
         - label: "I am willing to work on this issue (optional)"
           required: false
diff --git a/.github/workflows/save_articles.yml b/.github/workflows/save_articles.yml
@@ -1,4 +1,4 @@
-name: DevSync
+name: DevtoGitHub
 
 on:
   schedule:
@@ -15,7 +15,7 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Run DevSync
+      - name: Run DevtoGitHub
         uses: ./
         with:
           devApiKey: ${{ secrets.DEV_TOKEN }}

diff --git a/Contributing.md b/Contributing.md
@@ -18,8 +18,8 @@ Please take a moment to read the following guidelines before contributing:
 
 ## Found a bug?
 
-- **Ensure the bug was not already reported** by searching the existing [Issues](https://github.com/Anmol-Baranwal/DevSync/issues?q=is%3Aissue+).
-- If you're unable to find an open issue addressing the problem, open a new one using this [bug template](https://github.com/Anmol-Baranwal/DevSync/issues/new?assignees=&labels=bug&projects=&template=bug.yml&title=%5BBUG%5D+%3Cconcise+description%3E). Be sure to include a **title and clear description**, and as much relevant information as possible.
+- **Ensure the bug was not already reported** by searching the existing [Issues](https://github.com/Anmol-Baranwal/DevtoGitHub/issues?q=is%3Aissue+).
+- If you're unable to find an open issue addressing the problem, open a new one using this [bug template](https://github.com/Anmol-Baranwal/DevtoGitHub/issues/new?assignees=&labels=bug&projects=&template=bug.yml&title=%5BBUG%5D+%3Cconcise+description%3E). Be sure to include a **title and clear description**, and as much relevant information as possible.
 
 ## What should I know before submitting a pull request or issue
 
@@ -42,4 +42,4 @@ Because of how GitHub Actions are run, the source code of this project is transp
 
 ## Remarks ✅
 
-- If something is missing here, or you feel something is not well described, please [raise an issue](https://github.com/Anmol-Baranwal/DevSync/issues/new) with relevant template.
+- If something is missing here, or you feel something is not well described, please [raise an issue](https://github.com/Anmol-Baranwal/DevtoGitHub/issues/new) with relevant template.
diff --git a/Examples.md b/Examples.md
@@ -12,7 +12,7 @@ This will save your articles when `saveArticles` is set to `true` (default). You
 > Workflow code
 
 ```yml
-name: DevSync
+name: DevtoGitHub
 
 on:
   schedule:
@@ -29,16 +29,16 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Run DevSync
-        uses: Anmol-Baranwal/DevSync@v1
+      - name: Run DevtoGitHub
+        uses: Anmol-Baranwal/DevtoGitHub@v1
         with:
           devApiKey: ${{ secrets.DEV_TOKEN }}
           saveArticles: true # default
           outputDir: "articles" # this is default and it will save articles in "articles" directory
 ```
 
 > Output
-![saving articles](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/a5c18795-c74b-4833-a38b-22c22c8e2c19)
+![saving articles](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/ad357618-6fda-4f9e-b90d-39962dce9e9f)
 
 The structure of each article markdown file would be as follows:
 
@@ -50,7 +50,7 @@ The structure of each article markdown file would be as follows:
 - Content of the Article
 
 > Output
-![structure of saved article](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/6c1cc3c6-3b35-467b-8892-48dea28ea0d0)
+![structure of saved article](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/24fb6087-bec8-457f-8c3f-2205a08fd873)
 
 
 ## Table of Contents for Saved Articles
@@ -62,7 +62,7 @@ This will save your articles when `saveArticles` is set to `true` (default). You
 > Workflow code
 
 ```yml
-name: DevSync
+name: DevtoGitHub
 
 on:
   schedule:
@@ -79,8 +79,8 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Run DevSync
-        uses: Anmol-Baranwal/DevSync@v1
+      - name: Run DevtoGitHub
+        uses: Anmol-Baranwal/DevtoGitHub@v1
         with:
           devApiKey: ${{ secrets.DEV_TOKEN }}
           saveArticles: true # default
@@ -89,7 +89,7 @@ jobs:
 ```
 
 > Output
-![saving articles with table of contents](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/3ef5c665-b42a-4e1d-b769-4146d8e82259)
+![saving articles with table of contents](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/6093c3ff-9ae9-43f6-b70f-96cda5dd0ce1)
 
 
 ## Reading List
@@ -101,7 +101,7 @@ This will stop saving your articles since `saveArticles` is set to `false` (defa
 > Workflow code
 
 ```yml
-name: DevSync
+name: DevtoGitHub
 
 on:
   schedule:
@@ -118,8 +118,8 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Run DevSync
-        uses: Anmol-Baranwal/DevSync@v1
+      - name: Run DevtoGitHub
+        uses: Anmol-Baranwal/DevtoGitHub@v1
         with:
           devApiKey: ${{ secrets.DEV_TOKEN }}
           saveArticles: false # default is true
@@ -129,7 +129,7 @@ jobs:
 ```
 
 > Output
-![create reading list](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/b45d1e49-0a8b-4dc7-a41e-82649baa7aff)
+![create reading list](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/d13f89a7-7999-4dab-9efb-12094918d078)
 
 
 ## Reading List with read time
@@ -141,7 +141,7 @@ This will stop saving your articles since `saveArticles` is set to `false` (defa
 > Workflow code
 
 ```yml
-name: DevSync
+name: DevtoGitHub
 
 on:
   schedule:
@@ -158,8 +158,8 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Run DevSync
-        uses: Anmol-Baranwal/DevSync@v1
+      - name: Run DevtoGitHub
+        uses: Anmol-Baranwal/DevtoGitHub@v1
         with:
           devApiKey: ${{ secrets.DEV_TOKEN }}
           saveArticles: false # default is true
@@ -169,19 +169,19 @@ jobs:
 ```
 
 > Output
-![create a reading list with a reading time of the article](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/820cb75f-58c2-46ef-8845-5565f3f1fc37)
+![create a reading list with a reading time of the article](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/f5f6926d-ff73-4ad1-98d6-30833d9cf4e5)
 
 
 ## Reading List with excludeTags & mustIncludeTags
 
 > Explanation
 
-This will stop saving your articles since `saveArticles` is set to `false` (default is `true`). It will create your reading list with the articles in a structured way. You can change which directory you want using `outputDirReading`. For instance, the below workflow will save your articles in the root directory by adding your info in a `README`. You can read about excludeTags and mustIncludeTags in [detail with examples](https://github.com/Anmol-Baranwal/DevSync?tab=readme-ov-file#the-concept-of-excludetags-and-mustincludetags).
+This will stop saving your articles since `saveArticles` is set to `false` (default is `true`). It will create your reading list with the articles in a structured way. You can change which directory you want using `outputDirReading`. For instance, the below workflow will save your articles in the root directory by adding your info in a `README`. You can read about excludeTags and mustIncludeTags in [detail with examples](https://github.com/Anmol-Baranwal/DevtoGitHub?tab=readme-ov-file#the-concept-of-excludetags-and-mustincludetags).
 
 > Workflow code
 
 ```yml
-name: DevSync
+name: DevtoGitHub
 
 on:
   schedule:
@@ -198,8 +198,8 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Run DevSync
-        uses: Anmol-Baranwal/DevSync@v1
+      - name: Run DevtoGitHub
+        uses: Anmol-Baranwal/DevtoGitHub@v1
         with:
           devApiKey: ${{ secrets.DEV_TOKEN }}
           saveArticles: false # default is true
@@ -218,7 +218,7 @@ These options are not mandatory for everyone if you're not very familiar with Gi
 There are conventions for commit messages that make commits self-explanatory regarding their type. If `conventionalCommits` is set to `true` (default) then those conventions will be used. You can read more about [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
 
 > Output
-![conventional commits](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/4cd62814-6eb0-45c5-869b-20c624981c8c)
+![conventional commits](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/bfe6221b-cc5a-4eb7-92f8-32f33f3945e1)
 
 
 > Git Branch
@@ -240,4 +240,4 @@ In case you are looking for cron schedules, here are some common ones that you c
 
 <br />
 
-You can see the list of [input options](https://github.com/Anmol-Baranwal/DevSync?tab=readme-ov-file#inputs) that you can use with the workflow.
+You can see the list of [input options](https://github.com/Anmol-Baranwal/DevtoGitHub?tab=readme-ov-file#inputs) that you can use with the workflow.
diff --git a/GetStarted.md b/GetStarted.md
@@ -11,11 +11,11 @@ Once you are logged into your DEV account, go to [dev.to/settings/extensions](ht
 
 In the `DEV API Keys` section, create a new key by adding a description and clicking on `Generate API Key`.
 
-![DEV API KEY](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/a654edc3-9a21-4737-93e2-3cb0f761c585)
+![DEV API KEY](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/014f0454-31c9-47d5-93b7-d5e80ad08a1d)
 
 You'll see the newly generated key in the same view. 
 
-![DEV API KEY](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/db73ffe1-2a92-4390-a263-4170df63c540)
+![DEV API KEY](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/6f87b450-96e5-4e86-b077-0f36d12cafd5)
 
 Store this key and proceed to the next step.
 
@@ -27,13 +27,13 @@ You can follow official documentation on [how to create a repository on GitHub](
 
 Sign in to your [GitHub](https://github.com/), select `+` in the upper right corner, and then click `new repository`.
 
-![new repository](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/5d977197-b461-4dee-b188-a63452ea2313)
+![new repository](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/351d3bd7-64ea-4918-ba3f-f74cfe0ae5a5)
 
 Fill in details and type a name for your repository with an optional description.
 
 You can choose `private` if you don't want others to access your posts or reading list saved in the repository. Other things like `LICENSE` are optional. It's up to you if you want to include it.
 
-![details of new repository](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/cc6943ba-4ae6-4352-b8aa-4ee36708069b)
+![details of new repository](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/c910cb73-56ab-4843-b75e-04b990248e2c)
 
 <br />
 
@@ -45,16 +45,16 @@ To do this, go to repository `settings > Actions > General > Workflow` permissio
 
 Here is a screenshot of how you can find it.
 
-![actions for write permissions](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/55efbd08-8b76-4dd9-9308-ad71d213f177)
+![actions for write permissions](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/e4779e30-8a23-4514-a40e-1099fe0f904c)
 
 After you have granted your token the write permissions, you are all set to proceed to the next step.
 
 To do this, go to `settings > Secrets and variables > Actions` and then click on `New Repository Secret`.
 
-![repository secret](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/56e39242-d6aa-4881-8176-86545b63c919)
+![repository secret](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/6418164e-49e6-4459-b79f-77ec2a5b982a)
 
 Now you have to put the name as `DEV_TOKEN` (used in workflow) and `Secret` as the API key you generated earlier from DEV. 
 
-![repository secret](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/0501cd47-c7c5-45e9-a9a3-3711159a32f6)
+![repository secret](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/9dc41a39-a8fe-44e2-859f-2d7eed0e9114)
 
-Hooray 🎉 You're all set! You can now proceed to [creating a workflow file](https://github.com/Anmol-Baranwal/DevSync/tree/main?tab=readme-ov-file#-getting-started) mentioned in the README.
+Hooray 🎉 You're all set! You can now proceed to [creating a workflow file](https://github.com/Anmol-Baranwal/DevtoGitHub/tree/main?tab=readme-ov-file#-getting-started) mentioned in the README.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-![DevSync Banner](https://github.com/Anmol-Baranwal/DevSync/assets/74038190/7c334d33-0eba-4914-aee2-ffe3bf02fc3b)
+![DevtoGitHub Banner](https://github.com/Anmol-Baranwal/DevtoGitHub/assets/74038190/839a978c-cfa3-4977-a7a4-5656354642e0)
 
-# DevSync
+# DevtoGitHub
 Save your DEV.to articles and reading list with a bunch of useful options.
 
 ## Use cases
@@ -26,7 +26,7 @@ Save your DEV.to articles and reading list with a bunch of useful options.
 - Create a file in the repository at the following path: `.github/workflows/dev-sync.yml` and paste the following code into it.
 
 ```yml
-name: DevSync
+name: DevtoGitHub
 
 on:
   schedule:
@@ -43,16 +43,16 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Run DevSync
-        uses: Anmol-Baranwal/DevSync@v1
+      - name: Run DevtoGitHub
+        uses: Anmol-Baranwal/DevtoGitHub@v1
         with:
           devApiKey: ${{ secrets.DEV_TOKEN }}
           saveArticles: true # default
           outputDir: "articles" # this will save the articles in "articles" directory
           saveArticlesReadme: true # this will create a table of content for easy navigation
 ```
 
-- For detailed instructions on custom configuration and visual samples, please refer to the [examples](./Examples.md). To get started, I've also mentioned some of the [common cron schedule](https://github.com/Anmol-Baranwal/DevSync/blob/main/Examples.md#other-options) for you to use in the workflow.
+- For detailed instructions on custom configuration and visual samples, please refer to the [examples](./Examples.md). To get started, I've also mentioned some of the [common cron schedule](https://github.com/Anmol-Baranwal/DevtoGitHub/blob/main/Examples.md#other-options) for you to use in the workflow.
 
 ---
 
@@ -102,7 +102,7 @@ Suppose we have an article with tags: `['react', 'javascript', 'frontend', 'tuto
 
 All changes are welcome. Please read our [contributing guidelines](Contributing.md)
 
-Feel free to suggest any features or report bugs using these [issue templates](https://github.com/Anmol-Baranwal/DevSync/issues/new/choose).
+Feel free to suggest any features or report bugs using these [issue templates](https://github.com/Anmol-Baranwal/DevtoGitHub/issues/new/choose).
 
 ---
 

diff --git a/dist/index.js b/dist/index.js
@@ -35,7 +35,7 @@ const createMarkdownFile_1 = __nccwpck_require__(6034);
 const core = __importStar(__nccwpck_require__(2186));
 const createReadingList_1 = __nccwpck_require__(8644);
 const fetchDevToReadingList_1 = __nccwpck_require__(3327);
-async function DevSync() {
+async function DevtoGitHub() {
     try {
         const apiKey = core.getInput("devApiKey");
         const outputDir = core.getInput("outputDir") || "./articles"; // Default is the articles directory
@@ -63,7 +63,7 @@ async function DevSync() {
         console.error("Error:", error.message);
     }
 }
-DevSync();
+DevtoGitHub();
 
 
 /***/ }),

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "devsync",
+  "name": "devtogithub",
   "version": "1.0.0",
   "description": "Save your dev.to articles with all the necessary information on GitHub",
   "main": "dist/index.js",
@@ -10,12 +10,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Anmol-Baranwal/DevSync.git"
+    "url": "git+https://github.com/Anmol-Baranwal/DevtoGitHub.git"
   },
   "bugs": {
-    "url": "https://github.com/Anmol-Baranwal/DevSync/issues"
+    "url": "https://github.com/Anmol-Baranwal/DevtoGitHub/issues"
   },
-  "homepage": "https://github.com/Anmol-Baranwal/DevSync#readme",
+  "homepage": "https://github.com/Anmol-Baranwal/DevtoGitHub#readme",
   "keywords": [],
   "exports": {
     ".": "./dist/index.js"