Skip to content

Commit 0e250b6

Browse files
docs(legacy)!: finalize v1.0.0 and guide users to upcoming monorepo (#55)
* feat: update to latest version of js sdk, docs and announcement * chore: remove reference to shared utilities in migration guide * docs: update SDK integration example in changelog
1 parent 29bdff8 commit 0e250b6

File tree

27 files changed

+1486
-1432
lines changed

27 files changed

+1486
-1432
lines changed

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ coverage/
3030
# Development tools
3131
.husky/
3232

33-
# Documentation
34-
docs/
35-
3633
# Operating system files
3734
.DS_Store
3835
.DS_Store?

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
---
8+
9+
## [v1.0.0] - 2025-10-27
10+
11+
### Added
12+
13+
- Initial release of the Auth0 ACUL sample app.
14+
- Includes a single auth0-acul-js SDK integration example.
15+
- Basic documentation and setup instructions.
16+
17+
### Deprecated
18+
19+
- This version is now superseded by the upcoming **v2.0.0 (monorepo)** release.
20+
21+
---
22+
23+
## [Unreleased]
24+
25+
### Planned
26+
27+
- Merge of the `monorepo-sample` branch into `main`
28+
- Addition of multiple framework samples (React, JS/TS)
29+
- Introduction of automated changelog and release tagging via GitHub Actions

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Auth0 Advanced Customizations for Universal Login Template
22

3+
> ⚠️ **Important Notice (Oct 2025):**
4+
> This repository is being restructured into a **monorepo** that will host multiple framework-specific samples (React SDK, JS/TS SDK, etc.).
5+
> If you’re looking for the **previous single-sample version**, please use the **v1.x** tag:
6+
>
7+
> ```bash
8+
> git clone https://github.com/auth0-samples/auth0-acul-samples.git
9+
> cd auth0-acul-samples
10+
> git checkout v1.0.0
11+
> ```
12+
>
13+
> The new monorepo version will be released on **Oct 31, 2025**.
14+
15+
---
16+
317
This project provides a production-ready template for creating custom Auth0 Advanced Customizations for Universal Login (ACUL) screens using React, TypeScript, and Tailwind CSS. The template follows the same design language and user experience patterns as Auth0's Universal Login screens while integrating with the [Auth0 ACUL SDK](https://github.com/auth0/universal-login) to provide seamless authentication functionality.
418
519
**What is ACUL?** Advanced Customizations for Universal Login (ACUL) is an Early Access capability that allows you to build custom, client-rendered versions of Universal Login screens, giving you control over every pixel of your authentication experience. ACUL uses a client/server model where you have full control over the client-side interface while leveraging the security, extensibility, and flexibility of Universal Login's hosted authentication on the server side.
@@ -296,3 +310,23 @@ We welcome contributions! Here's how you can help:
296310
- **Community Discussion:** [Auth0 Community Forum](https://community.auth0.com/)
297311
- **Documentation:** [Auth0 ACUL Docs](https://auth0.com/docs/customize/login-pages/advanced-customizations)
298312
- **Feature Requests:** [Open a discussion](https://github.com/auth0-samples/auth0-acul-samples/discussions)
313+
314+
---
315+
316+
## Migration and Legacy Information
317+
318+
If your project depends on the old structure, you can continue using the **v1.x** releases.
319+
320+
See the [Migration Guide](./docs/migration-guide.md) for details on:
321+
322+
- What has changed in the monorepo structure
323+
- How to migrate
324+
- How to stay on the legacy version safely
325+
326+
---
327+
328+
## Changelog
329+
330+
See [CHANGELOG.md](./CHANGELOG.md) for a full list of changes between releases.
331+
332+
---

docs/migration-plan.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Migration Guide — v1.x → v2.0.0 (Monorepo)
2+
3+
## Overview
4+
5+
Starting from **v2.0.0**, this repository has been restructured into a **monorepo**.
6+
Each framework-specific sample now lives under its own folder at the repository root.
7+
8+
```
9+
/react/ → React SDK sample
10+
/react-js/ → JS/TS SDK sample
11+
/docs/ → Documentation and migration guides
12+
```
13+
14+
---
15+
16+
## Why This Change?
17+
18+
- To simplify maintaining multiple samples in one repository
19+
- To reduce duplication and standardize setup/configuration
20+
- To enable automated releases and changelogs
21+
- To support CI/CD pipelines for sample validation
22+
23+
---
24+
25+
## How to Stay on the Old Version
26+
27+
If your existing projects depend on the old structure:
28+
29+
```bash
30+
git checkout v1.0.0
31+
```
32+
33+
That version will remain available indefinitely as the last **v1.x (legacy)** release.
34+
35+
---
36+
37+
## Breaking Changes
38+
39+
| Area | Change | Notes |
40+
| ---------------- | ------------------------------------------------------ | --------------------------------------------- |
41+
| Folder structure | Sample code moved into framework-specific folders | Adjust your paths and setup steps accordingly |
42+
| Scripts | Each sample now has its own `package.json` and scripts | Run commands per sample directory |
43+
| Dependencies | Version bumps and reorganized modules | Check each sample’s `package.json` |
44+
| Documentation | Moved into `/docs/` | Updated setup and run instructions |
45+
46+
---
47+
48+
## Next Steps
49+
50+
- Explore the new monorepo structure (`v2.0.0+`)
51+
- Read each sample’s local `README.md` for setup
52+
- Refer to the root [CHANGELOG.md](../CHANGELOG.md) for detailed updates
53+
- Open issues or PRs if you encounter migration problems

jest.config.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ module.exports = {
1111
'^@/(.*)$': '<rootDir>/src/$1',
1212
},
1313
// Allow transforming ESM modules from node_modules.
14-
transformIgnorePatterns: ['/node_modules/(?!@auth0/auth0-acul-js/)'],
14+
transformIgnorePatterns: ['/node_modules/(?!(friendly-challenge|@auth0/auth0-acul-js)/)'],
1515
setupFilesAfterEnv: ['<rootDir>/src/test/setup.ts'],
1616
};

0 commit comments

Comments
 (0)