├── .gitignore ├── _index ├── posts ├── _static │ └── imgs │ │ └── github.png └── thanks-for-using.md ├── _tpl ├── post-footer.md └── post-header.md ├── .github └── workflows │ └── main.yml ├── Dockerfile ├── README.md ├── git-issues-blog.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | _index 2 | -------------------------------------------------------------------------------- /_index: -------------------------------------------------------------------------------- 1 | {"posts/thanks-for-using.md": 6, "__commit__": "d79d68ffe8084c2525278c98b01372b37b92e06e"} -------------------------------------------------------------------------------- /posts/_static/imgs/github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Sep0lkit/git-issues-blog/HEAD/posts/_static/imgs/github.png -------------------------------------------------------------------------------- /_tpl/post-footer.md: -------------------------------------------------------------------------------- 1 | 2 | ### Footer: 3 | 4 |
Powered By git-issues-blog
5 | -------------------------------------------------------------------------------- /_tpl/post-header.md: -------------------------------------------------------------------------------- 1 | ## Header: 2 | 3 | Author: [Sep0lkit](https://github.com/Sep0lkit) 4 | 5 | This article was generated from: {{ GITHUB_POSTS_URL }} 6 | 7 | -------------------------------------------------------------------------------- /posts/thanks-for-using.md: -------------------------------------------------------------------------------- 1 | # Thanks For Using 2 | 3 | Auto build issues blog from github repo. 4 | 5 | 6 | 7 | This is git-issues-blog examples, thanks for using. 8 | 9 | Generated From: https://github.com/Sep0lkit/git-issues-blog/blob/master/posts/thanks-for-using.md 10 | 11 | Github marketplace: https://github.com/marketplace/actions/git-issues-blog 12 | 13 | ### Update this post: 14 | 15 | Add for v1.2 testing. 16 | 17 | 18 | 19 | 20 | 21 | ![github](_static/imgs/github.png) -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: git issues blog workflow 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | paths: 8 | - 'posts/*.md' 9 | - 'posts/*/*.md' 10 | - 'posts/*/*/*.md' 11 | 12 | 13 | jobs: 14 | git-issues-blog: 15 | 16 | runs-on: ubuntu-latest 17 | 18 | steps: 19 | - uses: actions/checkout@v1 20 | with: 21 | ref: master 22 | - name: Publish Issues 23 | uses: ./ 24 | env: 25 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 26 | POSTS_PATH: 'posts' 27 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:3.7 2 | 3 | LABEL author="Sep0lkit " 4 | LABEL repository="https://github.com/Sep0lkit/git-issues-blog" 5 | 6 | # Github action labels 7 | LABEL com.github.actions.name="git-issues-blog" 8 | LABEL com.github.actions.author="Sep0lkit" 9 | LABEL com.github.actions.description="Auto build issues blog from github repo" 10 | LABEL com.github.actions.icon="file-text" 11 | LABEL com.github.actions.color="blue" 12 | 13 | # Install packages 14 | RUN apk add --no-cache bash git jq 15 | RUN apk add --no-cache python3 && python3 -m ensurepip && pip3 --no-cache-dir install --upgrade pip 16 | RUN pip3 install requests PyGithub pathlib 17 | 18 | 19 | COPY git-issues-blog.py /git-issues-blog.py 20 | RUN chmod +x /git-issues-blog.py 21 | ENTRYPOINT [ "/git-issues-blog.py" ] 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Git-Issues-Blog (Github-Action) 2 | [![GitHub Marketplace](https://img.shields.io/badge/marketplace-Git--Issues--Blog-green.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/git-issues-blog) 3 | 4 | A Github action to create issues from github repository. 5 | 6 | I use this action for my blog system, make me more focused on writing. 7 | 8 | ## **Features:** 9 | 10 | - **WYWIWYG**(What You Write Is What You Get) 11 | - Based on github file content 12 | - Automatically generate and update issues 13 | - Template support 14 | - Automatic conversion image link 15 | - Easy to using 16 | 17 | ## Example: 18 | 19 | ​ **Issues:** [Thanks-for-using.md](https://github.com/Sep0lkit/git-issues-blog/issues/6) 20 | 21 | ## Usage: 22 | 23 | ```yaml 24 | name: git issues blog workflow 25 | 26 | on: 27 | push: 28 | branches: 29 | - master 30 | paths: 31 | - 'posts/*.md' 32 | - 'posts/*/*.md' 33 | - 'posts/*/*/*.md' 34 | 35 | 36 | jobs: 37 | git-issues-blog: 38 | runs-on: ubuntu-latest 39 | steps: 40 | - uses: actions/checkout@v1 41 | with: 42 | ref: master 43 | - name: Git-Issues-Blog 44 | uses: Sep0lkit/git-issues-blog@v1.3 45 | env: 46 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 47 | POSTS_PATH: 'posts' 48 | 49 | ``` 50 | 51 | #### Environment variables 52 | - `POSTS_PATH` - blog posts folder name, default is "posts" 53 | 54 | #### Issues templates 55 | 56 | "_tpl/post-header.md" and "_tpl/post-footer.md" for templates, issues content will be: 57 | 58 | ​ **Issues = post-header.md + posts/example.md + post-footer.md** 59 | 60 | > tpl variables support: 61 | > 62 | > {{ GITHUB_POSTS_USER }} #github repository username 63 | > 64 | > {{ GITHUB_POSTS_URL }} #posts url in file but not issues. 65 | 66 | 67 | 68 | ## Something to do: 69 | 70 | - [ ] Posts by github user, but not github-action(github actions doesn't support now). 71 | 72 | -------------------------------------------------------------------------------- /git-issues-blog.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # Author: Sep0lkit 4 | # Github: https://github.com/Sep0lkit/git-issues-blo 5 | 6 | import os 7 | import re 8 | import json 9 | import pathlib 10 | import requests 11 | import subprocess 12 | import urllib.parse 13 | from github import Github 14 | from github import GithubException 15 | from github import UnknownObjectException 16 | 17 | GITHUB_API = "https://api.github.com" 18 | GITHUB_ACTION_NAME = os.environ['GITHUB_ACTION'] 19 | 20 | # Get environment variables 21 | GITHUB_TOKEN = os.environ['GITHUB_TOKEN'] 22 | GITHUB_REPO = os.environ['GITHUB_REPOSITORY'] 23 | GITHUB_USER = GITHUB_REPO.split('/')[0] 24 | GITHUB_BRANCH = os.getenv('GITHUB_BRANCH', 'master') 25 | POSTS_PATH = os.getenv('POSTS_PATH', 'posts') 26 | POST_INDEX_FILE = os.getenv('POST_INDEX_FILE', '_index') 27 | # Global variables 28 | POSTS = [] 29 | CHANGED = [] 30 | 31 | 32 | # github object 33 | g = Github(GITHUB_TOKEN) 34 | repo = g.get_repo(GITHUB_REPO) 35 | 36 | # local dictionary 37 | dictionary = {} 38 | index = pathlib.Path(POST_INDEX_FILE) 39 | if index.exists(): 40 | try: 41 | with open(POST_INDEX_FILE, encoding='utf-8', mode = 'r') as f: 42 | dictionary = json.load(f) 43 | lastcommit = dictionary['__commit__'] 44 | command = "git diff --name-only -z " + lastcommit 45 | changed = subprocess.check_output(['git', 'diff', '--name-only', '-z', lastcommit]) 46 | for x in changed.split(b'\x00'): 47 | if x.decode('utf-8'): 48 | CHANGED.append(x.decode('utf-8')) 49 | f.close() 50 | except Exception as e: 51 | print('%s load error: %s' % (POST_INDEX_FILE, e)) 52 | exit(-1) 53 | 54 | 55 | p = pathlib.Path(POSTS_PATH) 56 | for f in p.rglob('*.md'): 57 | if len(CHANGED) != 0: 58 | if (f.as_posix() in CHANGED): 59 | print("post %s need update" % f.as_posix()) 60 | POSTS.append(f) 61 | else: 62 | POSTS.append(f) 63 | 64 | print("posts need update: ") 65 | print(POSTS) 66 | 67 | header = pathlib.Path('_tpl/post-header.md') 68 | if header.exists(): 69 | issue_header = header.read_text() 70 | else: 71 | issue_header = "" 72 | 73 | footer = pathlib.Path('_tpl/post-footer.md') 74 | if footer.exists(): 75 | issue_footer = footer.read_text() 76 | else: 77 | issue_footer = "\n\nPowered by [Git-Issues-Blog](https://github.com/marketplace/actions/git-issues-blog)" 78 | 79 | # issues tpl variables function 80 | def parse_issue_tpl(content, user, path): 81 | #GITHUB_POSTS_USER 82 | content = re.sub(r'{{\s?GITHUB_POSTS_USER\s?}}', user , content, flags=re.M) 83 | #GITHUB_POSTS_FILENAME 84 | postname = path.rsplit('/',1)[1] 85 | content = re.sub(r'{{\s?GITHUB_POSTS_NAME\s?}}', postname , content, flags=re.M) 86 | #GITHUB_POSTS_URL 87 | url = "https://github.com/{}/blob/{}/{}".format(GITHUB_REPO, GITHUB_BRANCH, urllib.parse.quote(path)) 88 | content = re.sub(r'{{\s?GITHUB_POSTS_URL\s?}}', url , content, flags=re.M) 89 | 90 | return content 91 | 92 | for p in POSTS: 93 | # issue content templat)e 94 | with open(p, encoding='utf-8', mode = 'r') as f: 95 | issue_body = f.read() 96 | f.close() 97 | 98 | # relative link to raw.github link 99 | re_format = "![\\1](https://raw.githubusercontent.com/{}/{}/{}/\\2)".format(GITHUB_REPO, GITHUB_BRANCH, p.parent.as_posix()) 100 | issue_body_with_giturl = re.sub(r'!\[(.*)\]\((?!http)(.*)\)', re_format, issue_body, flags = re.M) 101 | 102 | # template variables in header and footer 103 | issue_header_with_tpl = parse_issue_tpl(issue_header, GITHUB_USER, p.as_posix()) 104 | issue_footer_with_tpl = parse_issue_tpl(issue_footer, GITHUB_USER, p.as_posix()) 105 | 106 | issue_content = issue_header_with_tpl + issue_body_with_giturl + issue_footer_with_tpl 107 | 108 | # check file exist issue or not by title(POSTS_PATH) 109 | pstr = p.as_posix() 110 | if pstr in dictionary: 111 | # get issue info 112 | issue_number = dictionary[pstr] 113 | try: 114 | issue = repo.get_issue(number=issue_number) 115 | 116 | issue_url = issue.html_url 117 | issue_title = issue.title 118 | 119 | # content 120 | payload = {} 121 | payload['title'] = issue_title 122 | payload['body'] = issue_content 123 | 124 | # github edit issue api 125 | header = {'Authorization': 'token %s' % GITHUB_TOKEN} 126 | 127 | url = GITHUB_API + "/repos/" + GITHUB_REPO + "/issues/" + str(issue_number) 128 | r = requests.patch(url, headers=header, data=json.dumps(payload)) 129 | if r.status_code == 200: 130 | print("issue update successful: %s" % issue_number) 131 | else: 132 | print("issue update failed: %s" % issue_number) 133 | exit(-1) 134 | except GithubException as e: 135 | print('get issues: %s error, skip for next' % issue_number) 136 | 137 | else: 138 | #creat issue 139 | title = p.name 140 | title = re.sub('.md$', '', title, flags=re.IGNORECASE) 141 | issue = repo.create_issue(title, issue_content) 142 | print("issue create successfule: %s" % issue.number) 143 | dictionary[pstr] = issue.number 144 | 145 | commit = os.environ['GITHUB_SHA'] 146 | print("update posts to commit id: %s" % commit) 147 | if re.search("^\w{40}$", commit): 148 | dictionary['__commit__'] = commit 149 | else: 150 | print('last commit id got error') 151 | exit(-1) 152 | 153 | #write posts index and commit step 154 | try: 155 | repo.get_contents(POST_INDEX_FILE,ref=GITHUB_BRANCH) 156 | except UnknownObjectException: 157 | repo.create_file(POST_INDEX_FILE, "add post index: _index", "{}", branch=GITHUB_BRANCH) 158 | #update POST_INDEX_FILE 159 | post_index_file = repo.get_contents(POST_INDEX_FILE,ref=GITHUB_BRANCH) 160 | post_index_content = json.dumps(dictionary, ensure_ascii=False) 161 | post_index_msg = "rebuild posts index from: " + GITHUB_ACTION_NAME 162 | repo.update_file(post_index_file.path, post_index_msg, post_index_content, post_index_file.sha, branch=GITHUB_BRANCH) 163 | 164 | print("posts update successful") 165 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------