Por que as Versões Estáveis e as Notas de Lançamento não batem?

OK – Sempre me perguntei isso, então vou questionar…

Recebo e-mails da nossa instância do Discourse informando que uma “Nova versão” está disponível.
Há um link: “Veja o que há de novo nas Notas de Lançamento…”
Mas, ao clicar no link, não há nenhuma menção a essa nova versão ou às suas notas de lançamento.

Olhe aqui – dizia que a nova versão é a 2.5.2, mas agora veja a tela para onde o link aponta: você vê alguma menção às notas de lançamento da versão 2.5.2?

Então, em vez de me ajudar, o link me frustrou.

Isso é só comigo?

2.5.2 é estável, com mudanças mínimas; as novas versões são beta.

Obrigado, mas só para estarmos na mesma página…
O link diz que me leva às notas de versão 2.5.2, mas não leva. Em lugar nenhum dessa página ou link há menção às notas de versão 2.5.2.
A mesma coisa aconteceu no último anúncio.

Normalmente, não fazemos notas de lançamento para atualizações estáveis, pois elas geralmente envolvem mudanças extremamente pequenas, apenas correções de bugs essenciais que foram transferidas de volta, etc. É possível que você possa extrair as alterações estáveis do GitHub por meio de um link especial; talvez @jomaxro tenha uma ideia.

Geralmente, recomendamos que você permaneça na versão ‘tests-passed’. Todos os nossos clientes e provedores de hospedagem estão na versão ‘tests-passed’.

Jeff está correto, não escrevo notas de lançamento para versões estáveis. O e-mail que você recebeu é um e-mail padrão, compartilhado por todas as instâncias do Discourse. Ele não sabe em qual branch você está.

Versões pontuais estáveis incluem apenas correções de bugs críticos e patches de segurança. Diferentemente de nossas versões normais, que contêm centenas de alterações, as versões pontuais estáveis geralmente têm menos de 10, muitas vezes muito menos.

Você pode ver todas as alterações em https://github.com/discourse/discourse/commits/stable. Procure por “Version bump to v{versão atual}” e “Version bump to v{versão anterior}”. Tudo entre eles são as alterações. No caso da v2.5.2, há 7 alterações: 3 de segurança, 2 seguidas de alterações de segurança e 2 correções críticas de desempenho.

Entendido. Seu raciocínio para não criar notas de versão para lançamentos estáveis faz certo sentido. Meu único ponto é que MUITOS de nós recebemos notificações por e-mail e, NA MAIORIA das vezes, o link das Notas de Versão não diz nada. Uma opção é alterar o modelo para estabelecer expectativas de forma mais clara, em vez de eu ser provocado e, geralmente, clicar para encontrar nada relacionado ao e-mail que acabei de receber.

Se fosse nosso produto, eu levaria 10 minutos para criar uma nota de versão para cada lançamento.
Basta dizer: “Este é um lançamento menor. Baixo risco. Principalmente correções de bugs. Mas alteramos a forma como xxx é tratado, caso queira ficar ciente dessa melhoria ou de um possível impacto.”

De qualquer forma - estou bem.

Proponho que o modelo padrão de e-mail de atualização seja atualizado:

Substituir
"Veja o que há de novo nas notas de lançamento "
por
“Revire estas notas de lançamento e tente descobrir o que há nesta nova versão, já que não há notas de lançamento para esta versão”

Contexto
Recebi outro e-mail hoje informando que a versão 2.7.1 está disponível e indicando o link para as notas de lançamento, que não contém uma nota para a versão 2.7.1. O link deve ser útil ou omitido.

Oi, Bill,

Tivemos algumas discussões internas. Como imagino que você entenda, não vamos alterar o texto para o que você propôs. Embora ainda recomendemos que os sites permaneçam em tests-passed, como é o padrão, vamos criar notas de lançamento para as versões estáveis daqui para frente. Note que as notas não incluirão o mesmo nível de detalhe que as notas de lançamento normais, pois os incrementos de versão estável incluem apenas correções críticas de bugs e patches de segurança.

Muito bem. Peço desculpas pelo tom sarcástico, mas quando recebo o aviso de um novo lançamento, quero imediatamente clicar no link para ver como essa versão pode impactar meus usuários e qual a prioridade para fazer a atualização, etc. No entanto, sempre fico frustrado porque o link não faz isso e, na maioria dos casos, não há documentos com o mesmo número de versão referenciados na atualização. Agora, preciso decidir quanto tempo devo dedicar à busca de documentos específicos para esse lançamento, etc. Obviamente, um documento com a palavra “beta” ou um número de versão anterior pode ser significativamente diferente do lançamento final, então esses documentos não me são úteis.

Obrigado por levar isso adiante.

Para referência futura, o changelog efetivo para um salto de versão estável importante, como 2.5.0, é a soma de todas as versões beta que começam com a versão: 2.5.0.beta[1,2,3,4,5,6,7]. Nos esforçamos para manter as versões “beta” utilizáveis o tempo todo, e nossa branch “estável” está mais focada na ausência de mudanças do que na ausência de bugs.

Esperamos que as notas de lançamento da correção ajudem a esclarecer a confusão.

As notas de lançamento dos dois últimos patches estáveis estão disponíveis.