phoenix changelog

Hey there, Phoenix enthusiasts! We've got some exciting updates to share with you that are sure to make your development experience even smoother and more secure. Let's dive into the latest improvements to our documentation, which are all about making authentication and authorization in Phoenix applications as clear and effective as possible. 🚀

  • Improvement: Updates to Scope Guide
    We've revamped the scope guide to give it a fresh new look! We've swapped out those old "Demo" names for the snazzier "MyApp" to keep things consistent and crystal clear. The guide now puts a spotlight on the importance of scopes in managing user sessions and permissions, which are crucial for keeping your app's data access on lockdown. Plus, we've added some nifty code snippets to show you how to set up scopes and manage user sessions like a pro. 🛡️

  • Improvement: Updates to Auth Section
    Say hello to the new "Introduction to Auth" guide! This gem breaks down the basics of authentication and authorization in Phoenix, complete with handy links to resources like the mix phx.gen.auth generator. We've also expanded the guide on mix_phx_gen_auth to include all the juicy details on features like user registration and magic link logins. And don't worry, we've reorganized things a bit to make the whole auth journey more intuitive for you. 🧙‍♂️

  • Improvement: Update API Auth Guide
    The API authentication guide got a makeover to keep up with the new phx.gen.auth and scopes features. This update makes sure you're armed with the latest and greatest in authentication practices, so you can integrate these new functionalities with ease. Say goodbye to confusion and hello to a seamless user experience! 🔑

We hope these updates make your Phoenix development journey a little brighter and a whole lot easier. Happy coding! 🌟

Included Commits

2025-03-11T12:46:46 See commit

The commit updates the API authentication guide to align with the new phx.gen.auth feature and the implementation of scopes. This enhancement ensures that the documentation reflects the latest developments in authentication practices, providing users with clearer instructions on how to utilize the new functionalities effectively.

Overall, the changes aim to improve the user experience by offering updated guidance that incorporates the latest features and best practices in API authentication, thereby facilitating easier integration for developers.

Files changed

2025-03-11T12:50:00 See commit

This commit introduces significant updates to the authentication (authn) and authorization (authz) sections of the documentation, including the addition of a new guide titled "Introduction to Auth," which outlines the fundamental concepts of authentication and authorization, and their implementation in the Phoenix framework. The new guide emphasizes the built-in support for these features and provides links to relevant resources, such as the mix phx.gen.auth generator and the newly introduced "Scopes" mechanism for managing resource access based on user identity and permissions. Additionally, the guide also touches upon token-based API authentication, encouraging developers to explore third-party libraries like Ueberauth for supplemental functionalities.

Furthermore, the existing "mix_phx_gen_auth" guide has been renamed and expanded to detail the features of the authentication system generated by mix phx.gen.auth, including user registration, magic link logins, and privileged authentication modes. The updates enhance clarity and usability for developers by providing comprehensive information on the generated authentication modules, including plugs for user authentication and session management. The commit also includes modifications to the project configuration files to reflect the new organization of the guides, ensuring a more intuitive structure for users seeking to implement authentication and authorization in their Phoenix applications.

Files changed

  • guides/authn_authz/api_authentication.md
  • guides/authn_authz/authn_authz.md
  • guides/authn_authz/mix_phx_gen_auth.md
  • mix.exs
2025-03-11T13:09:47 See commit

This commit introduces updates to the scope guide for a Phoenix application, primarily focusing on the authentication and authorization modules. Key changes include a modification in example app names from "Demo" to "MyApp" to enhance clarity and consistency. The documentation now emphasizes the purpose of scopes as crucial data structures that manage user sessions and permissions, thereby reinforcing their importance in application security and data access control. The guide also details the integration of scopes within Phoenix generators, explaining how default scopes can be defined and utilized in generated resources.

Additionally, the commit refines explanations around the structure and functionality of scope modules, clarifying the role of various parameters such as module, assign_key, and schema_type. It includes code snippets that illustrate how to set up scopes and manage user sessions effectively, while also highlighting the potential for custom scope implementations. Overall, these updates aim to improve the understanding of authentication and authorization mechanisms in Phoenix applications, ensuring developers can effectively implement secure access controls.

Files changed

  • guides/authn_authz/mix_phx_gen_auth.md
  • guides/authn_authz/scopes.md