Merge pull request #9 from elias-AD/support_different_cloud_urls

Support different Confluence URL patterns
update readme to make it more clear
2025-09-06 15:50:39 +00:00 · 2024-12-17 15:00:58 +01:00 · 2024-11-28 09:34:59 -05:00 · 2024-11-28 09:29:50 -05:00 · 2024-11-27 23:19:05 -05:00 · 2023-03-30 10:19:55 +02:00
8 changed files with 139 additions and 97 deletions
--- a/.dockerignore
+++ b/.dockerignore
@@ -0,0 +1,3 @@
+*
+!Pipfile*
+!src
--- a/.gitignore
+++ b/.gitignore
@@ -2,7 +2,8 @@
 .venv

 # Dev
+.env
 .vscode
 Test.md
-.github/workflows
+.github/workflows/dev.yaml
 *.secrets
--- a/14
+++ b/14
@@ -1,12 +1,12 @@
-FROM python:3.9-alpine
-
-WORKDIR /tmp
-RUN pip install pipenv
-COPY ./Pipfile* ./
-RUN pipenv install --system --deploy
-
+FROM python:3.10-alpine

 WORKDIR /action
+
+COPY ./Pipfile* ./
+RUN pip install pipenv && \
+  pipenv install --system --deploy && \
+  pipenv --clear
+
 COPY ./src .

 ENTRYPOINT [ "python" ]
--- a/3
+++ b/3
@@ -7,10 +7,11 @@ name = "pypi"
 requests = "*"
 markdown = "*"
 py-gfm = "*"
+python-dotenv = "*"

 [dev-packages]
 autopep8 = "*"
 mypy = "*"

 [requires]
-python_version = "3.9"
+python_version = "3.10"
--- a/Pipfile.lock
+++ b/Pipfile.lock
@@ -1,11 +1,11 @@
 {
    "_meta": {
        "hash": {
-            "sha256": "88ca19a4a790aab7be54f3279f465695c5ab1d77b1bd3e9e6e0ae1b55952445e"
+            "sha256": "d6b13a7d2799118601293cb0223043b384b6904d96f267f21ce4a596d59ac954"
        },
        "pipfile-spec": 6,
        "requires": {
-            "python_version": "3.9"
+            "python_version": "3.10"
        },
        "sources": [
            {
@@ -18,97 +18,113 @@
    "default": {
        "certifi": {
            "hashes": [
-                "sha256:78884e7c1d4b00ce3cea67b44566851c4343c120abd683433ce934a68ea58872",
-                "sha256:d62a0163eb4c2344ac042ab2bdf75399a71a2d8c7d47eac2e2ee91b9d6339569"
+                "sha256:35824b4c3a97115964b408844d64aa14db1cc518f6562e8d7261699d1350a9e3",
+                "sha256:4ad3232f5e926d6718ec31cfc1fcadfde020920e278684144551c91769c7bc18"
            ],
-            "version": "==2021.10.8"
+            "markers": "python_full_version >= '3.6.0'",
+            "version": "==2022.12.7"
        },
        "charset-normalizer": {
            "hashes": [
-                "sha256:e019de665e2bcf9c2b64e2e5aa025fa991da8720daa3c1138cadd2fd1856aed0",
-                "sha256:f7af805c321bfa1ce6714c51f254e0d5bb5e5834039bc17db7ebe3a4cec9492b"
+                "sha256:5a3d016c7c547f69d6f81fb0db9449ce888b418b5b9952cc5e6e66843e9dd845",
+                "sha256:83e9a75d1911279afd89352c68b45348559d1fc0506b054b346651b5e7fee29f"
            ],
-            "markers": "python_version >= '3'",
-            "version": "==2.0.7"
+            "markers": "python_full_version >= '3.6.0'",
+            "version": "==2.1.1"
        },
        "idna": {
            "hashes": [
-                "sha256:84d9dd047ffa80596e0f246e2eab0b391788b0503584e8945f2368256d2735ff",
-                "sha256:9d643ff0a55b762d5cdb124b8eaa99c66322e2157b69160bc32796e824360e6d"
+                "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4",
+                "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2"
            ],
-            "markers": "python_version >= '3'",
-            "version": "==3.3"
+            "markers": "python_version >= '3.5'",
+            "version": "==3.4"
        },
        "markdown": {
            "hashes": [
-                "sha256:31b5b491868dcc87d6c24b7e3d19a0d730d59d3e46f4eea6430a321bed387a49",
-                "sha256:96c3ba1261de2f7547b46a00ea8463832c921d3f9d6aba3f255a6f71386db20c"
+                "sha256:08fb8465cffd03d10b9dd34a5c3fea908e20391a2a90b88d66362cb05beed186",
+                "sha256:3b809086bb6efad416156e00a0da66fe47618a5d6918dd688f53f40c8e4cfeff"
            ],
            "index": "pypi",
-            "version": "==3.3.4"
+            "version": "==3.4.1"
        },
        "py-gfm": {
            "hashes": [
-                "sha256:c4e873f310a84137acae5884a15e81a18eac17da9c00b20d5d9b82d37fd2d077",
-                "sha256:ef3a3e6e54817c21e97cc16c85789b0681e62958823a0ba3e3d29f8509d9dc49"
+                "sha256:8768b31bbfda8e1d52e2f32b363c138eedf52b1a81c06036b60ece576b2a652f",
+                "sha256:c49f43b584e15bdbe569141c92aefc00542289b6d88d95b38117e3359a35cdfe"
            ],
            "index": "pypi",
-            "version": "==1.0.2"
+            "version": "==2.0.0"
+        },
+        "python-dotenv": {
+            "hashes": [
+                "sha256:1684eb44636dd462b66c3ee016599815514527ad99965de77f43e0944634a7e5",
+                "sha256:b77d08274639e3d34145dfa6c7008e66df0f04b7be7a75fd0d5292c191d79045"
+            ],
+            "index": "pypi",
+            "version": "==0.21.0"
        },
        "requests": {
            "hashes": [
-                "sha256:6c1246513ecd5ecd4528a0906f910e8f0f9c6b8ec72030dc9fd154dc1a6efd24",
-                "sha256:b8aa58f8cf793ffd8782d3d8cb19e66ef36f7aba4353eec859e74678b01b07a7"
+                "sha256:7c5599b102feddaa661c826c56ab4fee28bfd17f5abca1ebbe3e7f19d7c97983",
+                "sha256:8fefa2a1a1365bf5520aac41836fbee479da67864514bdb821f31ce07ce65349"
            ],
            "index": "pypi",
-            "version": "==2.26.0"
+            "version": "==2.28.1"
        },
        "urllib3": {
            "hashes": [
-                "sha256:4987c65554f7a2dbf30c18fd48778ef124af6fab771a377103da0585e2336ece",
-                "sha256:c4fdf4019605b6e5423637e01bc9fe4daef873709a7973e195ceba0a62bbc844"
+                "sha256:47cc05d99aaa09c9e72ed5809b60e7ba354e64b59c9c173ac3018642d8bb41fc",
+                "sha256:c083dd0dce68dbfbe1129d5271cb90f9447dea7d52097c6e0126120c521ddea8"
            ],
-            "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'",
-            "version": "==1.26.7"
+            "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'",
+            "version": "==1.26.13"
        }
    },
    "develop": {
        "autopep8": {
            "hashes": [
-                "sha256:44f0932855039d2c15c4510d6df665e4730f2b8582704fa48f9c55bd3e17d979",
-                "sha256:ed77137193bbac52d029a52c59bec1b0629b5a186c495f1eb21b126ac466083f"
+                "sha256:8b1659c7f003e693199f52caffdc06585bb0716900bbc6a7442fd931d658c077",
+                "sha256:ad924b42c2e27a1ac58e432166cc4588f5b80747de02d0d35b1ecbd3e7d57207"
            ],
            "index": "pypi",
-            "version": "==1.6.0"
+            "version": "==2.0.0"
        },
        "mypy": {
            "hashes": [
-                "sha256:088cd9c7904b4ad80bec811053272986611b84221835e079be5bcad029e79dd9",
-                "sha256:0aadfb2d3935988ec3815952e44058a3100499f5be5b28c34ac9d79f002a4a9a",
-                "sha256:119bed3832d961f3a880787bf621634ba042cb8dc850a7429f643508eeac97b9",
-                "sha256:1a85e280d4d217150ce8cb1a6dddffd14e753a4e0c3cf90baabb32cefa41b59e",
-                "sha256:3c4b8ca36877fc75339253721f69603a9c7fdb5d4d5a95a1a1b899d8b86a4de2",
-                "sha256:3e382b29f8e0ccf19a2df2b29a167591245df90c0b5a2542249873b5c1d78212",
-                "sha256:42c266ced41b65ed40a282c575705325fa7991af370036d3f134518336636f5b",
-                "sha256:53fd2eb27a8ee2892614370896956af2ff61254c275aaee4c230ae771cadd885",
-                "sha256:704098302473cb31a218f1775a873b376b30b4c18229421e9e9dc8916fd16150",
-                "sha256:7df1ead20c81371ccd6091fa3e2878559b5c4d4caadaf1a484cf88d93ca06703",
-                "sha256:866c41f28cee548475f146aa4d39a51cf3b6a84246969f3759cb3e9c742fc072",
-                "sha256:a155d80ea6cee511a3694b108c4494a39f42de11ee4e61e72bc424c490e46457",
-                "sha256:adaeee09bfde366d2c13fe6093a7df5df83c9a2ba98638c7d76b010694db760e",
-                "sha256:b6fb13123aeef4a3abbcfd7e71773ff3ff1526a7d3dc538f3929a49b42be03f0",
-                "sha256:b94e4b785e304a04ea0828759172a15add27088520dc7e49ceade7834275bedb",
-                "sha256:c0df2d30ed496a08de5daed2a9ea807d07c21ae0ab23acf541ab88c24b26ab97",
-                "sha256:c6c2602dffb74867498f86e6129fd52a2770c48b7cd3ece77ada4fa38f94eba8",
-                "sha256:ceb6e0a6e27fb364fb3853389607cf7eb3a126ad335790fa1e14ed02fba50811",
-                "sha256:d9dd839eb0dc1bbe866a288ba3c1afc33a202015d2ad83b31e875b5905a079b6",
-                "sha256:e4dab234478e3bd3ce83bac4193b2ecd9cf94e720ddd95ce69840273bf44f6de",
-                "sha256:ec4e0cd079db280b6bdabdc807047ff3e199f334050db5cbb91ba3e959a67504",
-                "sha256:ecd2c3fe726758037234c93df7e98deb257fd15c24c9180dacf1ef829da5f921",
-                "sha256:ef565033fa5a958e62796867b1df10c40263ea9ded87164d67572834e57a174d"
+                "sha256:0714258640194d75677e86c786e80ccf294972cc76885d3ebbb560f11db0003d",
+                "sha256:0c8f3be99e8a8bd403caa8c03be619544bc2c77a7093685dcf308c6b109426c6",
+                "sha256:0cca5adf694af539aeaa6ac633a7afe9bbd760df9d31be55ab780b77ab5ae8bf",
+                "sha256:1c8cd4fb70e8584ca1ed5805cbc7c017a3d1a29fb450621089ffed3e99d1857f",
+                "sha256:1f7d1a520373e2272b10796c3ff721ea1a0712288cafaa95931e66aa15798813",
+                "sha256:209ee89fbb0deed518605edddd234af80506aec932ad28d73c08f1400ef80a33",
+                "sha256:26efb2fcc6b67e4d5a55561f39176821d2adf88f2745ddc72751b7890f3194ad",
+                "sha256:37bd02ebf9d10e05b00d71302d2c2e6ca333e6c2a8584a98c00e038db8121f05",
+                "sha256:3a700330b567114b673cf8ee7388e949f843b356a73b5ab22dd7cff4742a5297",
+                "sha256:3c0165ba8f354a6d9881809ef29f1a9318a236a6d81c690094c5df32107bde06",
+                "sha256:3d80e36b7d7a9259b740be6d8d906221789b0d836201af4234093cae89ced0cd",
+                "sha256:4175593dc25d9da12f7de8de873a33f9b2b8bdb4e827a7cae952e5b1a342e243",
+                "sha256:4307270436fd7694b41f913eb09210faff27ea4979ecbcd849e57d2da2f65305",
+                "sha256:5e80e758243b97b618cdf22004beb09e8a2de1af481382e4d84bc52152d1c476",
+                "sha256:641411733b127c3e0dab94c45af15fea99e4468f99ac88b39efb1ad677da5711",
+                "sha256:652b651d42f155033a1967739788c436491b577b6a44e4c39fb340d0ee7f0d70",
+                "sha256:6d7464bac72a85cb3491c7e92b5b62f3dcccb8af26826257760a552a5e244aa5",
+                "sha256:74e259b5c19f70d35fcc1ad3d56499065c601dfe94ff67ae48b85596b9ec1461",
+                "sha256:7d17e0a9707d0772f4a7b878f04b4fd11f6f5bcb9b3813975a9b13c9332153ab",
+                "sha256:901c2c269c616e6cb0998b33d4adbb4a6af0ac4ce5cd078afd7bc95830e62c1c",
+                "sha256:98e781cd35c0acf33eb0295e8b9c55cdbef64fcb35f6d3aa2186f289bed6e80d",
+                "sha256:a12c56bf73cdab116df96e4ff39610b92a348cc99a1307e1da3c3768bbb5b135",
+                "sha256:ac6e503823143464538efda0e8e356d871557ef60ccd38f8824a4257acc18d93",
+                "sha256:b8472f736a5bfb159a5e36740847808f6f5b659960115ff29c7cecec1741c648",
+                "sha256:b86ce2c1866a748c0f6faca5232059f881cda6dda2a893b9a8373353cfe3715a",
+                "sha256:bc9ec663ed6c8f15f4ae9d3c04c989b744436c16d26580eaa760ae9dd5d662eb",
+                "sha256:c9166b3f81a10cdf9b49f2d594b21b31adadb3d5e9db9b834866c3258b695be3",
+                "sha256:d13674f3fb73805ba0c45eb6c0c3053d218aa1f7abead6e446d474529aafc372",
+                "sha256:de32edc9b0a7e67c2775e574cb061a537660e51210fbf6006b0b36ea695ae9bb",
+                "sha256:e62ebaad93be3ad1a828a11e90f0e76f15449371ffeecca4a0a0b9adc99abcef"
            ],
            "index": "pypi",
-            "version": "==0.910"
+            "version": "==0.991"
        },
        "mypy-extensions": {
            "hashes": [
@@ -119,27 +135,27 @@
        },
        "pycodestyle": {
            "hashes": [
-                "sha256:720f8b39dde8b293825e7ff02c475f3077124006db4f440dcbc9a20b76548a20",
-                "sha256:eddd5847ef438ea1c7870ca7eb78a9d47ce0cdb4851a5523949f2601d0cbbe7f"
+                "sha256:347187bdb476329d98f695c213d7295a846d1152ff4fe9bacb8a9590b8ee7053",
+                "sha256:8a4eaf0d0495c7395bdab3589ac2db602797d76207242c17d470186815706610"
            ],
-            "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'",
-            "version": "==2.8.0"
+            "markers": "python_version >= '3.6'",
+            "version": "==2.10.0"
        },
-        "toml": {
+        "tomli": {
            "hashes": [
-                "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b",
-                "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"
+                "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc",
+                "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"
            ],
-            "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'",
-            "version": "==0.10.2"
+            "markers": "python_version < '3.11'",
+            "version": "==2.0.1"
        },
        "typing-extensions": {
            "hashes": [
-                "sha256:49f75d16ff11f1cd258e1b988ccff82a3ca5570217d7ad8c5f48205dd99a677e",
-                "sha256:d8226d10bc02a29bcc81df19a26e56a9647f8b0a6d4a83924139f4a8b01f17b7",
-                "sha256:f1d25edafde516b146ecd0613dabcc61409817af4766fbbcfb8d1ad4ec441a34"
+                "sha256:1511434bb92bf8dd198c12b1cc812e800d4181cfcb867674e0f8279cc93087aa",
+                "sha256:16fa4864408f655d35ec496218b85f79b3437c829e93320c7c9215ccfd92489e"
            ],
-            "version": "==3.10.0.2"
+            "markers": "python_version >= '3.7'",
+            "version": "==4.4.0"
        }
    }
 }
--- a/README.md
+++ b/README.md
@@ -27,11 +27,17 @@ jobs:

 Uses basic auth for the rest api.

- `cloud`: The ID can be found by looking at yout confluence domain: `https://xxx.atlassian.net/...`
+- `cloud`: Can be either:
+  - A subdomain (`acme` for Atlassian hosted instances (e.g. `https://acme.atlassian.net`))
+  - A full URL (e.g., `https://mycompany.com` for self-hosted instances)
+
 - `user`: The user that generated the access token
+
 - `token`: You can generate the token [here](https://id.atlassian.com/manage-profile/security/api-tokens). Link to [Docs](https://confluence.atlassian.com/cloud/api-tokens-938839638.html)

- `to`: The page ID can be found by simply navigating to the page where you want the content to be postet to and looke at the url. It will look something like this: `https://<cloud-id>.atlassian.net/wiki/spaces/<space>/pages/<page-id>/<title>`
+- `to`: The page ID can be found by simply navigating to the page where you want the content to be posted to and look at the url. It will look something like this: 
+  - For Atlassian hosted: `https://<subdomain>.atlassian.net/wiki/spaces/<space>/pages/<page-id>/<title>`
+  - For self-hosted: `https://<your-url>/wiki/spaces/<space>/pages/<page-id>/<title>`

 ### Using secrets

@@ -39,7 +45,7 @@ It's **higly reccomended** that you use secrets!

 To use them you need them to specify them before in your repo. [Docs](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets)

-The you can use them in any input field.
+Then you can use them in any input field.

 ```yml
 # .github/workflows/my-workflow.yml
@@ -47,12 +53,16 @@ The you can use them in any input field.
 token: ${{ secrets.token }}
 ```

+## Known Limitations
+
+For now images will not be uploaded [see ticket](https://github.com/cupcakearmy/confluence-markdown-sync/issues/5), they would require extra steps. If anyone feedls brave enough, constributions are welcomed :)
+
 ## Development

 1. Clone the repo
 2. Install [act](https://github.com/nektos/act)
 3. Create the same config in the repo folder as in the getting started section above.
-4. Change `uses: cupcakearmy/confluence-markdown-sync@v1` -> `uses: ./`
+4. Change `uses: cupcakearmy/confluence-markdown-sync` -> `uses: ./`
 5. Create an example markdown file `Some.md` and set it in the config `from: './Some.md'`
 6. Run locally `act -b`

--- a/action.yml
+++ b/action.yml
@@ -1,25 +1,25 @@
 # action.yml
-name: 'confluence-markdown-sync'
-description: 'Copy content of a markdown file to a confluence site'
+name: confluence-markdown-sync
+description: Copy content of a markdown file to a confluence site
 branding:
-  icon: 'upload-cloud'  
-  color: 'blue'
+  icon: upload-cloud
+  color: blue
 inputs:
  from:
-    description: 'Path to the markdown file. Relative to root of repository'
+    description: Path to the markdown file. Relative to root of repository
    required: true
  to:
-    description: 'The page ID in confluence'
+    description: The page ID in confluence
    required: true
  cloud:
-    description: 'Atlassian Cloud ID'
+    description: Atlassian Cloud ID
    required: true
  user:
-    description: 'Username of the token user'
+    description: Username of the token user
    required: true
  token:
-    description: 'Token for the user'
+    description: Token for the user
    required: true
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: docker
+  image: Dockerfile
--- a/src/main.py
+++ b/src/main.py
@@ -1,26 +1,37 @@
-from typing import Dict
 from os import environ
 from os.path import join
+from typing import Dict

 import requests
+from dotenv import load_dotenv
 from markdown import markdown
 from mdx_gfm import GithubFlavoredMarkdownExtension

+load_dotenv()
+
 workspace = environ.get('GITHUB_WORKSPACE')
 if not workspace:
-    raise Exception('No workspace is set')
+    print('No workspace is set')
+    exit(1)

 envs: Dict[str, str] = {}
 for key in ['from', 'to', 'cloud', 'user', 'token']:
    value = environ.get(f'INPUT_{key.upper()}')
    if not value:
-        raise Exception(f'Missing value for {key}')
+        print(f'Missing value for {key}')
+        exit(1)
    envs[key] = value

 with open(join(workspace, envs['from'])) as f:
    md = f.read()

-url = f"https://{envs['cloud']}.atlassian.net/wiki/rest/api/content/{envs['to']}"
+base_url = envs['cloud']
+if '://' in base_url:  # It's a full URL
+    # Remove trailing slash if present
+    base_url = base_url.rstrip('/')
+    url = f"{base_url}/wiki/rest/api/content/{envs['to']}"
+else:  # It's a subdomain
+    url = f"https://{base_url}.atlassian.net/wiki/rest/api/content/{envs['to']}"

 current = requests.get(url, auth=(envs['user'], envs['token'])).json()
Author	SHA1	Message	Date
Nicco	e3c11d1f58	Merge pull request #9 from elias-AD/support_different_cloud_urls Support different Confluence URL patterns	2024-12-17 15:00:58 +01:00
elias-AD	e43940725b	update readme to make it more clear	2024-11-28 09:34:59 -05:00
elias-AD	a59824adbb	modified `cloud` to support both subdomains (*.atlassian.net) or actual domains (e.g. ame.jira.com) instead of introducing a potential breaking change, this will support both cases	2024-11-28 09:29:50 -05:00
elias-AD	090b5472c5	support_cloud_URLs Instead of relying only on .atlassian.net, modify the input to be cloudUrl so different flavours of Confluence URLs can be used (including .jira.com).	2024-11-27 23:19:05 -05:00
Nicco	0d3d395931	typo	2023-03-30 10:19:55 +02:00
Nicco	aefcf035d8	Update README.md	2023-03-30 10:18:10 +02:00
cupcakearmy	93af96cd42	load dotenv	2022-12-08 17:24:06 +01:00
cupcakearmy	b38b874a2c	cleanup	2022-12-08 16:00:30 +01:00
cupcakearmy	5c70f435c1	update deps and optimize dockerfile	2022-12-08 15:57:33 +01:00
Nicco	1779f1b903	Update README.md	2021-10-27 13:49:59 +02:00
Nicco	67d0f1dba0	Update README.md	2021-10-27 13:48:10 +02:00