Wikis provisionados vs. código publicado como wiki

  • Artigo

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

No Azure DevOps, você pode manter seu conteúdo wiki em um wiki de projeto de equipe ou em um wiki publicado como código. Com um wiki publicado como código, você pode manter vários wikis versionados para dar suporte às suas necessidades de conteúdo, embora ele esteja disponível somente se o Azure Repos estiver habilitado.

Embora ambas as opções mantenham o conteúdo wiki em repositórios Git, a maneira como você adiciona, atualiza e gerencia o conteúdo wiki é diferente.

Observação

O recurso publicar código como wiki está atualmente disponível no Azure DevOps Server 2018 e versões posteriores. Para versões mais antigas, você só pode provisionar um wiki para seu projeto de equipe.

Opções do menu da página Wiki

Com um wiki provisionado, você pode adicionar e editar páginas diretamente dentro do wiki. Todas as atualizações de conteúdo para um wiki provisionado ocorrem dentro do wiki.

Com um código de publicação como wiki, você pode adicionar, editar e atualizar conteúdo de Repositórios ou Código.

A imagem a seguir mostra opções para um wiki provisionado. Várias dessas opções não são suportadas para a publicação como páginas wiki de código.

Captura de tela das opções do menu da página wiki provisionada.

Por exemplo, a opção Editar em Repositórios para o código de publicação como wiki leva você à página Repositório para editar essa página específica. As atualizações feitas em uma página na ramificação selecionada para o wiki são publicadas automaticamente no wiki.

Recursos suportados e diferenças operacionais

Ambos os tipos de wiki suportam os seguintes recursos:

A tabela a seguir resume as operações ou recursos que podem diferir, dependendo do tipo de wiki.

Operação Wiki provisionado Publicar código como wiki
Suporte a vários wikis, wiki de nome ✔️
Adicionar ou editar páginas de arquivos de repositório>ou arquivos de código> ✔️
Reverter para uma revisão anterior da Wiki ✔️
Reverter para uma revisão anterior de Repos ou Code ✔️ ✔️
Manter wikis versionados ✔️
Selecione uma versão wiki ✔️
Cancelar a publicação de um wiki de código ✔️

Adicionar páginas

Para ambos os tipos de wiki, selecione Nova página ou Adicionar subpágina. Para obter mais informações, consulte Adicionar e editar páginas wiki.

Sequência de páginas e lista de páginas no painel de navegação

O wiki provisionado gerencia a sequência de páginas e a lista de páginas automaticamente à medida que você adiciona ou move páginas no painel de navegação.

Para estruturar a lista de páginas no painel de navegação para um código de publicação como wiki, defina o arquivo .order na raiz e para cada subpasta ou página pai que contenha subpáginas.

Ambos os tipos de wikis seguem a mesma estrutura de arquivos, só que o código de publicação como wiki requer que você mantenha a sequência de páginas manualmente.

Para obter mais informações sobre como trabalhar com arquivos .order , consulte Arquivos de repositório Wiki Git e estrutura de arquivos.

Revisões de página e reversão para uma versão anterior

A partir da wiki, você pode ver as revisões de qualquer página wiki. Selecione Revisões ou a opção de menu Exibir revisões .

Mas, o processo de reversão difere dependendo do tipo de página wiki.

  • Para uma página wiki provisionada, selecione Reverter, conforme descrito em Reverter uma confirmação para uma página wiki provisionada
  • Para uma página wiki de publicação como código, trabalhe a partir de uma ramificação local e envie uma solicitação pull para atualizar a ramificação na qual você está trabalhando.

Controle de versão e cancelamento de publicação de um wiki

Com o controle de versão, você pode publicar diferentes versões de conteúdo em wikis distintas, com base em uma ramificação versionada de um repositório Git. O controle de versão e a despublicação de um wiki são suportados apenas para wikis que você criou publicando código em um wiki. Para obter mais informações, consulte Publicar um wiki de código/Cancelar a publicação de um wiki de código.

Excluir um wiki de projeto

Observação

As APIs REST do Wiki não oferecem suporte à exclusão de um wiki do projeto. Então, você tem que excluir o repositório wiki em vez disso.

  1. Clone o repositório wiki para fazer backup de todo o seu conteúdo. As opções Mais tem a URL wiki clone, que pode ser usada para clonar a wiki.

  2. Obtenha o ID do repositório git que apoia seu wiki. Você pode usar a API REST para obter todos os wikis no projeto.

    Por exemplo, GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1 retorna todos os wikis no projeto, para que você possa escolher qual excluir.

  3. Use a API REST para excluir o repositório Git de suporte. Use o ID do repositório do wiki do projeto que você encontrou na etapa anterior e verifique novamente o ID do repositório, para não remover o errado.

    Por exemplo, DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/{repositoryId}?api-version=4.1

Atualizar um wiki offline

Você pode trabalhar offline ou em uma ramificação local para atualizar o conteúdo de um wiki provisionado e publicar como wiki de código. Para obter mais informações, consulte Clonar e atualizar páginas wiki offline.