Skip to content

Commit

Permalink
Merge pull request #6 from a11smiles/iss3
Browse files Browse the repository at this point in the history
updated version and doc
  • Loading branch information
a11smiles authored Oct 14, 2022
2 parents 3d88d01 + c693be4 commit d0521cd
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .deepsource.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ enabled = true

[[analyzers]]
name = "javascript"
enabled = false
enabled = true
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"cSpell.words": [
"languaged"
]
}
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ GitSync is a workflow action that bidirectionally syncs GitHub and Azure DevOps
* Syncs public comments to Azure DevOps discussions, including code, images, etc.
* Internal teams can maintain private, internal discussions on work items, while allowing public users to contribute to the public discussion.

## Known Limitations

* Any GitHub Issues that have syntax-formatted code blocks (e.g. any code blocks that identify a specific language) will be "de-languaged" when Azure DevOps saves the work item. This is because Azure DevOps doesn't honor native markdown and, though a class name is correctly created initially, Azure DevOps removes the class name of the code block upon saving. Therefore, when the work item is sync'ed back to GitHub, the code block loses syntax highlighting. The process is similar to what's shown below:

| GitHub Issue | Converted To Html | Azure DevOps Saved<br />Html (No class name) | Converted Back to Markdown,<br /> Issue Updated (No syntax highlighting) |
| :----------- | :--------------- | ----------------------- | -------------------------------------- |
| <pre>\`\`\`javascript<br /># Some code<br />\`\`\`</pre> | <pre>&lt;code&gt;<br />&nbsp;&nbsp;&nbsp;&lt;pre<nobr /> class="javascript"&gt;<br />&nbsp;&nbsp;&nbsp;# Some code<br />&nbsp;&nbsp;&nbsp;&lt;/pre&gt;<br />&lt;/code&gt;</pre> | <pre>&lt;code&gt;<br />&nbsp;&nbsp;&nbsp;&lt;pre&gt;<br />&nbsp;&nbsp;&nbsp;# Some Code<br />&nbsp;&nbsp;&nbsp;&lt;/pre&gt;<br />&lt;/code&gt;</pre> | <pre>\`\`\`<br /># Some Code<br />\`\`\`</pre> |

## Configuration

There are two configuration files that will need to be added - the workflow file and the action configuration file, itself. Below are samples of each followed by a description.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "github-actions-gitsync",
"version": "1.1.3",
"version": "1.1.6",
"description": "A workflow action that syncs GitHub and Azure DevOps activities.",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit d0521cd

Please sign in to comment.