[BUG] Cannot POST to the /pages API with source[path]=\

[khemarato]

Select Topic Area

Bug

Body

Trying to create a new GitHub Page from the REST API with the source path set to / should work according to the documentation. In actuality, it returns an error that you have to create a gh-pages branch first.

The workaround for this is that you have to first POST with build_type=workflow and then switch over to build_type=legacy deploy via a PUT request.

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[Jemjeqt]

Here's the concise text solution for the GitHub Pages REST API issue:
To create a GitHub Page via REST API when source path is set to '/':
Current Issue:
The direct POST request fails with an error requiring 'gh-pages' branch creation first, despite documentation suggesting it should work.
Solution/Workaround:

First, make a POST request with build_type=workflow
Then, follow up with a PUT request to change build_type=legacy

This two-step process will successfully create and deploy your GitHub Page without needing to manually create the gh-pages branch.
Note: This appears to be a discrepancy between the API documentation and actual implementation. Consider reporting this as a documentation issue to GitHub.

[21hs]

Problema atual: Ao tentar criar uma página do GitHub usando a API REST com o caminho de origem configurado como '/', a solicitação POST falha com um erro indicando que a ramificação 'gh-pages' precisa ser criada primeiro. Isso ocorre apesar da documentação sugerir que a criação da ramificação não é necessária.

Solução/alternativa:

Primeiramente, envie uma solicitação POST com o parâmetro build_type=workflow.
Após isso, faça uma solicitação PUT para alterar o valor de build_type para legacy.
Esse procedimento em duas etapas permitirá que você crie e implante sua página do GitHub com sucesso, sem a necessidade de criar manualmente a ramificação 'gh-pages'.

Observação: Parece haver uma discrepância entre a documentação da API e o comportamento atual da implementação. Seria interessante considerar a abertura de um relato de problema sobre isso na documentação do GitHub.