I want to use AsciiDoc for documentation purposes and check the documentation into the Git repository next to the code. The AsciiDoc source files I want to be compiled to PDF during build and to be part of the build artifacts. Is there a plugin for VSTS, or a best practise for an on-premise windows build agent?
For Now, AsciiDoc is not supported for VSTS.
But there has related user voices suggest this feature, like Add Preview for AsciiDoc (.adoc) files in addition to Markdown and Add support for asciidoc, particular for README.adoc like github has. And you can vote and follow up the user voices.
Another link to the idea page.
Related
I have everyting automated with CloudBuild and additionally I'd like to create a GitHub release using the CloudBuild. In short, I prepare binary files and then I want to create a GitHub release using those files.
I cannot find any working example. What should the appropriate step look like?
Additionally, I'm not sure about the authentication between GitHub <-> CloudBuild.
You can refer to the Documentation (click GitHub cli tab) where
how to create a release using CLI is explained stepwise.
There is also a separated command Doc for how to add files to
the release.
To use Github Cli in cloud build , the best Practice would be to use
community builder , for more information how to use it you can refer
to the Documentation where Readme contains a more detailed
view.
For more information, you can visit to the Public Documentation where it is mentioned as :
This page explains how to use community-contributed builders and
custom builders in Cloud Build. The Cloud Build developer community
provides open-source builders that you can use to execute your
tasks. If the task you want to perform requires capabilities that are
not provided by an existing image, you can build your own custom image
and use it in a build step. To learn about the different types of
builders, see Cloud Builders.
When you publish a Package on GitHub Package Registry, you can optionally create a description of the Package. Unfortunately, I wrote a description that no longer adequately describes the code in the repo. How do I change the description?
There is no edit option for the published packages? Also, there is no versioning for that file. Every time you need to freshly create and that too only in the GitHub web app?.
Cool, I see an option pops in a week to edit without changing any access.
We are using TFS 2015 On Premise, not in the cloud and I am trying to give access to Stakeholders so they can access the wiki. However, as a stakeholder I keep getting this error:
TF400409: You do not have licensing rights to access this feature: Code
After researching the error it seems to be related to the fact that Stakeholders do not have access to view Code Wikis as shown here. That link is for Azure DevOps and I am not sure if it applies to my case but I cannot find anything else so my assumption is it does apply. Even links within our TFS site, takes us to Azure DevOps for help and thus my assumption is it applies to us as well.
Here is a screenshot from the aforementioned link:
Question
What is the difference between Code Wikis and Project Wikis? It seems I need Project Wikis but how do I create a Project Wiki?
Thanks in advance!
Code Wiki are not available on TFS server 2015. You need to use version TFS 2018 or above for this.
Project Wiki
Every team project can have a wiki. Use the wiki to share information
with your team to understand and contribute to your project.
Each team project wiki is powered by a Git repository in the back-end.
When you create a team project, a Wiki Git repo is not created by
default. Provision a Git repository to store your wiki Markdown files,
or publish existing Markdown files from a Git repository to a wiki.
In the project page, you could directly choose to create project wiki.
Code Wiki
Content that you already maintain in a Git repository can be published to a wiki. For example, this could be content written to
support a software development kit (SDK), product documentation, or
README file. You can publish multiple wikis within a single team
project.
More details about the difference of them, kindly refer our official doc here:
Provisioned wikis vs. published code as a wiki
As how to use them in Azure DevOps/TFS, you could also take a look at this step by step tutorial -- Collaborating using Azure DevOps Wiki
In Azure Devops, there is the possibility to view Readme.md files, but I would like to include/merge some text from another .md-file into that document. Or perhaps combine them in a wiki.
I am not able to find documentation on doing these kind of operations.
I have heard of tools like Pandoc and Sphinx, but I am not sure if Azure Devops supports that on their web app.
Markdown syntax supports include other md files [link text](file-name.md), however these files can only be rendered as links.
It seems azure devops does not support pandoc or sphinx, for I could not find any related extensions on azure devops marketplace.
There is a suggestion that you can build your README.md file using pandoc to include/merge other md files, or other methods mentioned in the thread #eskwayrd commented, before you commit to your repo.
I have developed a tiny library that I chose to host on GitHub. The code is being built by a VSTS build and published as a NuGet package.
I have written a README.md file and I am trying to include a Build badge on it, as described in the Microsoft documentation. Consequently, I have added the following line in the MD file and replaced the placeholders accordindly:
The problem is that the link is not accessible to anyone that is not logged-in on VSTS and I end up with a 'broken' link on my readme page:
Question
What must be done to make the VSTS Build Badge available to a GitHub repo?
I suppose you must include an authentication token of sorts in order to have at least read-access to the VSTS build from your GitHub page.
Note that the documentation lists also multiple pending issues, including MicrosoftDocs/vsts-docs issue 1499:
Build status badge added to GitHub readme doesn't show up.
So this is still in progress.
On that last issue, it says:
This is due to public vs. private projects.
If you make your project public the image URL will render.
There are other potential workarounds we are looking at for the doc.
See "Change the project visibility, public or private".